地域相关接口API文档

Size: px

Start display at page:

Download "地域相关接口API文档"

敦郁
5 years ago
Views:

1 云服务器地域相关接口 API 文档

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

3 文档目录文档声明... 2 查询可用区... 4 查询可用区能力... 7 获取产品对应的地域列表... 9 第 3 页共 10 页

4 查询可用区 1. 接口描述本接口 (DescribeAvailabilityZones) 用于查询腾讯云可用区的详细信息接口请求域名 :cvm.api.qcloud.com 可用区的定义请参看产品文档中的地域一节内容包括可用区具体的 IDC 可以指定可用区 ID 来查看单一可用区的信息可用区 ID 列表如下 : 可用区名称可用区 ID 北京一区上海一区广州一区广州二区广州三区香港一区北美一区输入参数以下请求参数列表仅列出了接口请求参数, 其它参数见公共请求参数页面参数名称是否必选类型描述 zoneid 否 Int 可用区 ID 3. 输出参数参数名称类型描述 code Int 错误码 (0: 成功, 其他值 : 失败 ) 第 4 页共 10 页

5 参数名称类型描述 message String 错误信息 totalcount Int 可用区的数目 zoneset Array 可用区数组 zoneset 是一个可用区信息的集合, 单个可用区信息的数据结构如下 : 参数名称类型描述 zoneid Int 可用区 ID idclist Array IDC 列表 idclist 是可用区下属 IDC 信息的集合, 单个 IDC 信息的数据结构如下 : 参数名称类型描述 idcid Int IDC 的 ID 值 idcname String IDC 名称 4. 示例输入 &< 公共请求参数 > zoneid= 输出 "code" : 0, "message" : "", "totalcount" : 1 "zoneset" : "zonename": " 广州一区 ", 第 5 页共 10 页

6 "idclist": [ "idcid": 685, "idcname": " 广州电信亚太信息 AC2 楼 " "idcid": 737, "idcname": " 广州电信亚太信息 AC4 楼 02" "idcid": 798, "idcname": " 广州移动南方基地 AC2 楼 " "idcid": 834, "idcname": " 广州电信人民中路 AC7 楼 " "idcid": 908, "idcname": " 广州电信石基 AC5 楼 " "idcid": 1035, "idcname": " 广州电信石基 AC4 楼 M2" "idcid": 1327, "idcname": " 广州电信石基 AC4 楼 M3" ], "zoneid": 第 6 页共 10 页

7 查询可用区能力 1. 接口描述本接口 (DescribeZoneAbility) 用于查询可用区的能力, 包括 CBS 云硬盘和 VPC 虚拟网络两种能力查询接口请求域名 :cvm.api.qcloud.com 2. 输入参数以下请求参数列表仅列出了接口请求参数, 其它参数见公共请求参数页面参数名称是否必选类型描述 zoneid 是 Int 可用区 ID capacity.n 是 String 要查询的能力 ; 目前支持 C BS 和 VPC 两种能力查询 ( 此接口支持同时传入多个 ID 此参数的具体格式可参考 API 简介的 id.n 一节 ) 3. 输出参数参数名称类型描述 code Int 公共错误码 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关详见错误码页面的模块错误码 capacityset Array 返回能力信息数组其中 capacityset 是一个能力信息的集合, 单个能力信息数据结构如下 : 参数名称类型描述 capacity Array 能力项第 7 页共 10 页

8 参数名称类型描述 issupported Int 是否满足 ;0 为不满足,1 为满足 4. 示例输入 &zoneid= &capacity.1=cbs &< 公共请求参数 > 输出 "code" : 0, "message" : "", "capacityset" : [ "issupported" : 1, "capacity" : [ "cbs" ] ] 第 8 页共 10 页

9 获取产品对应的地域列表 1. 接口描述本接口 (DescribeProductRegionList) 用于获取产品可使用的地域列表 i 接口请求域名 :trade.api.qcloud.com 可以直接查看产品文档中的地域一节来了解地域属性在产品中扮演的角色除了地域的限制,CVM 产品还有购买数量上的限制详情请参考 CVM 实例购买限制 2. 输入参数以下请求参数列表仅列出了接口请求参数, 其它参数见公共请求参数页面参数名称是否必选类型描述 instancetype 是 Int 实例类型 1: 云服务器 2: 云数据库 3: 负载均衡 3. 输出参数参数名称类型描述 code Int 公共错误码, 0 表示成功, 其他值表示失败详见错误码页面的公共错误码 message String 模块错误信息描述, 与接口相关详见错误码页面的模块错误码 availableregion Array 获取产品的可使用的地域信息列表, 其它 API 可能用到的参数 Region 可由此处获取, 如 gz 代表广州,sh 代表上海,hk 代表香港等 4. 示例第 9 页共 10 页

10 Powered by TCPDF ( 输入 &instancetype=1 &< 公共请求参数 > 输出 "code":0, "message": "", "availableregion ": "gz":" 广州 ", "sh":" 上海 ", "hk":" 香港地区 " 第 10 页共 10 页

参数管理接口API文档

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