解析记录相关接口API文档

Size: px

Start display at page:

Download "解析记录相关接口API文档"

吟久赵
4 years ago
Views:

1 域名解析解析记录相关接口 API 文档

2 版权声明腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品服务的当时的整体概况, 部分产品服务的内容可能有所调整您所购买的腾讯云产品服务的种类服务标准等应由您与腾讯云之间的商业合同约定, 除非双方另有约定, 否则, 腾讯云对本文档内容不做任何明示或模式的承诺或保证第 2 页共 19 页

3 文档目录文档声明... 2 创建记录... 4 查询关联记录任务... 7 查询记录... 9 查询关联记录详情启用记录暂停记录修改记录删除记录第 3 页共 19 页

4 创建记录 1. 接口描述本接口 (CreateResourceRecord) 用于创建一条新的解析记录接口请求域名 :cns.api.qcloud.com 1) 创建普通的解析记录操作是同步任务, 返回参数即可得知是否成功创建 2) 创建关联云资源的解析记录操作是异步任务, 需要根据返回参数 taskid 调用查询关联记录任务接口查看记录是否创建成功 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 CreateResourceRecord 若添加一条普通的解析记录, 输入参数如下 : type 是 Int 普通记录的值为 1 recordtype 是 String 记录类型可以取值 :A, CNAME,MX,NS,AAA A recordline 是 String 线路类型, 普通记录必传可取值 : 默认, 国外, 国内, 电信, 联通, 教育网, 移动, 铁通, 百度, 谷歌, 搜搜第 4 页共 19 页

5 recordvalue 是 String 记录值, 普通记录必传 ttl 否 Int 缓存生效时间最小值为 6 00, 最大值为 , 默认值为 600 mxlevel 否 Int MX 优先级如果是 MX 记录, 则这里必填, 取值范围 1-20 若添加一条关联云资源的解析记录 ( 简称关联记录 ), 输入参数如下 : type 是 Int 关联记录的值为 1 recordtype 是 String 记录类型只可以取值 :A resourcetype 是 String 关联资源类型, 关联记录必传 CVM-WAN: 云服务器 ( 公网 );CVM-LAN: 云服务器 ( 内网 );CDB: 云数据库 instanceids.n 是 String 关联实例 id,resourcetyp e 为 CDB 时, 只能关联一个实例 Id; 其他类型可以关联多个实例 Id ttl 否 Int 缓存生效时间最小值为 6 00, 最大值为 , 默认值为输出参数第 5 页共 19 页

6 参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 taskid Int 任务 Id 创建关联记录任务(type=2) 时输出, 可以通过查询关联记录任务接口 GetTaskResult 查询异步任务执行情况 4. 示例 &< 公共请求参数 > &domain=qcloud.com &subdomain=www &type=2 &recordtype=a &ttl=600 &resourcetype=cvm-wan &instanceids.1=qcvm12345 &instanceids.2=qcvm67890 返回示例如下 : { "code" : 0, "message" : "", "taskid": 123 } 第 6 页共 19 页

7 查询关联记录任务 1. 接口描述本接口 (GetTaskResult) 用于根据 taskid 查询关联记录任务的执行结果接口请求域名 :cns.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 GetTaskResult 参数名称必选类型描述 taskids 是 string json 格式字符串, 例如 :[1 3007, 13008] 3. 输出参数参数名称类型描述 succtask string 成功的任务 failtask string 失败的任务 processingtask string 正在执行中的任务 4. 示例 &< 公共请求参数 > &taskids=[13007, 13008] 返回示例如下 : { 第 7 页共 19 页

8 "code": 0, "message": "", "data": { "succtask": [ ], "failtask": [], "processingtask": [] } } 第 8 页共 19 页

9 查询记录 1. 接口描述本接口 (DescribeResourceRecord) 用于查询解析记录接口请求域名 :cns.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 DescribeResourceRecord domain 是 String 一级域名, 例如 qcloud.co m limit 否 Int 返回记录数量, 默认值为 2 0, 最大值 100 offset 否 Int 偏移量, 默认值为为 0 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 totalcount Int 域名记录总数 recordset Array 记录信息数组其中, 如果记录为普通记录,recordSet 参数的结构如下 : 参数名称类型描述第 9 页共 19 页

10 查询关联记录详情 1. 接口描述本接口 (DescribeResourceRecordDetail) 用于查询关联记录详情接口请求域名 :cns.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 DescribeResourceRecordDetail 参数名称是否必选类型描述 attachid 是 String 关联记录 ID 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 totalcount Int 域名记录总数 recordset Array 记录 cdb 信息数组 recordset 实例信息 -CVM 参数名称类型描述第 10 页共 19 页

11 启用记录 1. 接口描述本接口 (StartResourceRecord) 用于启用解析记录接口请求域名 :cns.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 CreateScalingPolicy 启动普通解析记录的参数结构如下 : recordid 是 String 普通记录 ID 启动关联云资源的解析记录的参数结构如下 : attachid 是 String 腾讯云实例关联记录 ID resourcetype 是 String 关联资源类型当启用腾讯云实例关联记录时必须传递第 11 页共 19 页

12 CVM-WAN: 云服务器 ( 公网 );CVM-LAN: 云服务器 ( 内网 );CDB: 云数据库 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 4. 示例 &< 公共请求参数 > &domain=qcloud.com &subdomain=www &recordid=123 返回示例如下 : { "code" : 0, "message" : "", } 第 12 页共 19 页

13 暂停记录 1. 接口描述本接口 (StopResourceRecord) 用于暂停解析记录接口请求域名 :cns.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 StopResourceRecord 启动普通解析记录的参数结构如下 : recordid 是 String 普通记录 ID 暂停关联云资源的解析记录的参数结构如下 : attachid 是 String 腾讯云实例关联记录 ID resourcetype 是 String 关联资源类型当暂停腾讯云实例关联记录时必须传递第 13 页共 19 页

14 CVM-WAN: 云服务器 ( 公网 );CVM-LAN: 云服务器 ( 内网 );CDB: 云数据库 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 4. 示例 &< 公共请求参数 > &domain=qcloud.com &subdomain=www &recordid=123 返回示例如下 : { "code" : 0, "message" : "", } 第 14 页共 19 页

15 修改记录 1. 接口描述本接口 (UpdateResourceRecord) 用于修改解析记录接口请求域名 :cns.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 UpdateResourceRecord 若修改一条普通的解析记录 ( 同步操作 ), 输入参数如下 : type 是 Int 普通记录的值为 1 recordtype 是 String 记录类型可以取值 :A, CNAME,MX,NS,AAA A recordid 是 String 普通记录 Id recordline 是 Int 线路类型, 普通记录必传可取值 :1: 默认,2: 国外,3: 国内,4: 电信,5 : 联通,6: 教育网,7: 移动,8: 铁通,9: 百度,10: 谷歌,11: 搜搜 recordvalue 是 String 记录值, 普通记录必传 ttl 否 Int 缓存生效时间最小值为 6 00, 最大值为 , 默第 15 页共 19 页

16 认值为 600 mxlevel 否 Int MX 优先级如果是 MX 记录, 则这里必填, 取值范围 1-20 若修改一条关联云资源的解析记录 ( 异步操作 ), 输入参数如下 : type 是 Int 关联记录的值为 2 recordtype 是 String 记录类型只可以取值 :A resourcetype 是 String 关联资源类型, 关联记录必传 CVM-WAN: 云服务器 ( 公网 );CVM-LAN: 云服务器 ( 内网 );CDB: 云数据库 attacheid 是 String 关联记录 Id addinstanceids.n 否 String 要增加的实例 ID resourc etypecdb 时, 只能操作一个实例 Id; 其他类型可以操作多个实例 Id delinstanceids.n 否 String 要删除的实例 ID resourc etypecdb 时, 只能操作一个实例 Id; 其他类型可以操作多个实例 Id ttl 否 Int 缓存生效时间最小值为 6 00, 最大值为 , 默认值为 600 第 16 页共 19 页

17 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 taskid Int 任务 Id,type2 时才有 4. 示例 &< 公共请求参数 > &domain=qcloud.com &subdomain=www &type=2 &recordtype=a &ttl=600 &resourcetype=cvm-wan &attachidrec=123 &addinstanceids.1=qcvm12345 返回示例如下 : { "code" : 0, "message" : "", "taskid": 123 } 第 17 页共 19 页

18 删除记录 1. 接口描述本接口 (DeleteResourceRecord) 用于删除解析记录接口请求域名 :cns.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 正式调用时需要加上公共请求参数, 见公共请求参数页面其中, 此接口的 Action 字段为 DeleteResourceRecord 删除一条普通解析记录的参数结构如下 : recordid 否 String 普通记录 ID, 当删除非腾讯云关联记录时必须传递删除一条关联云资源的解析记录的参数结构如下 : attachid 是 String 腾讯云实例关联记录 ID 当删除腾讯云实例关联记录时第 18 页共 19 页

19 Powered by TCPDF ( 必须传递 resourcetype 否 String 关联资源类型 CVM-WA N: 云服务器 ( 公网 );CVM -LAN: 云服务器 ( 内网 );CD B: 云数据库 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关 4. 示例 &< 公共请求参数 > &domain=api.qcloud.com &subdomain=www &recordid=123 返回示例如下 : { "code" : 0, "message" : "", } 第 19 页共 19 页

地域相关接口API文档

地域相关接口API文档云服务器地域相关接口 API 文档版权声明 2015-2016 腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品