接口功能介绍
该接口提供用户查询专属宿主机规格详细参数的功能,返回符合查询条件的专属宿主机的核数、内存和cpu超配比。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
确保当前宿主机存在于当前资源池(即参数decHostID与regionID对应)
URI
GET /v4/dec/host/type-show
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
azName | 否 | String | 可用区名称,您可以查看地域和可用区来了解可用区 获取: 查 资源池可用区查询 注:查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default) |
cn-huadong1-jsnj3A-public-ctcloud | |
hostID | 是 | String | 专属宿主机ID,获取: 查 查询专属宿主机列表 |
417cdb4b-de54-e5e5-62da-b78533a45b38 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页记录数目 | 1 | |
totalCount | Integer | 总记录数 | 1 | |
totalPage | Integer | 总页数 | 1 | |
results | Array of Objects | 分页明细 | results |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
vcpu | Integer | vCPU的数量 | 64 | |
cpuRatio | Integer | CPU的倍频 | 1 | |
memory | Integer | 总内存大小,单位MB | 512 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:查询专属宿主机的规格信息
{
"regionID":"a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj1A-public-ctcloud",
"hostID":"417cdb4b-de54-e5e5-62da-b78533a45b38"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"vcpu": 64,
"cpuRatio": 1,
"memory": 514204
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}0}
状态码
请参考 状态码
错误码
请参考 错误码