文档平台 API中心 云服务器 API 获取产品可用的地域列表

获取产品可用的地域列表

最近更新时间:2018-09-10 21:28:52

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

本接口 (DescribeProductRegionList) 用于获取产品可使用的地域列表。

接口请求域名:cvm.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. 示例

输入

https://cvm.api.qcloud.com/v2/index.php?Action=DescribeProductRegionList
 &instanceType=1
 &<公共请求参数>

输出

 {
      "code":0,
      "message": "",
      "availableRegion ":
      {
          "gz":"广州",
          "sh":"上海",
          "hk":"香港地区"
     }
  }