接口功能介绍
az信息获取接口。
接口约束
此功能为收费功能。确认已经购买服务器配额,并且开启服务器防护。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护。
URI
GET /v1/host/az
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
urlType | 是 | String | 请求地址类型。 | CTAPI | |
Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 200-成功 | ||
error | String | 返回码CTCSSCN_000000 :成功;CTCSSCN_000001:失败;CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用;CTCSSCN_000004:鉴权错误;CTCSSCN_000005:用户没有付费版配额,功能不可用 | CTCSSCN_000000 | |
message | String | 返回信息 | 成功 | |
returnObj | Object | 返回对象 | data |
表 data
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
regionId | String | 地域id | 100054c0416811e9a6690242ac110002 | |
regionName | String | 地域名称 | 保定 | |
azNameSet | Array of Strings | az列表 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
无
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": [{"regionId": "100054c0416811e9a6690242ac110002","regionName": "保定os","azNameSet": ["XX","XX"]},{"regionId": "9035c530814611e990660242ac110002","regionName": "重庆","azNameSet": ["XX","XX"]},{"regionId": "1f97eb062e8011e8a4bc0242ac110004","regionName": "北京","azNameSet": ["XX","XX"]},{"regionId": "85aa280c7d6911ea96030242ac11000a","regionName": "广西2-四川02-80","azNameSet": ["XX","XX"]},{"regionId": "ea072d783a4b11e584abe2ad47403cef","regionName": "贵州CS90.6","azNameSet": ["XX","XX"]}]}
状态码
请参考 状态码
错误码
请参考 错误码