You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
云机管理
查询云机详情 DetailHost
复制全文
下载 pdf
查询云机详情 DetailHost
此接口用于查询云机详情,您可通过业务 ID 和云机 ID 获取指定云机的详细信息。​
注意事项​
注意​
在调用本接口前,请先确认当前业务类型是否为本地存储。“云机”是本地存储业务的资源订购单位,因此,本接口仅适用于本地存储业务。对于采用云盘存储方案的业务,本接口不适用,请勿尝试调用。​
请求说明​
  • 请求方式:GET​
  • 请求地址:https://open.volcengineapi.com?Action=DetailHost&Version=2025-05-01​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Query​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
DetailHost​
接口名称。当前 API 的名称为 DetailHost。​
Version​
String​
是​
2025-05-01​
接口版本。当前 API 的版本为 2025-05-01。​
ProductId​
String​
是​
1749281594201xxxxxx​
业务 ID。可在云手机控制台 > 业务管理 > 业务详情中获取。​
HostId​
String​
是​
7337159054625xxxxxx​
云机 ID。可通过调用 ListHost 接口获取。​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。​
​
参数​
类型​
示例值​
描述​
AccountId​
String​
2100xxxxxx​
云机所属账号 ID。​
ProductId​
String​
1749281594201xxxxxx​
云机所属业务 ID。​
HostId​
String​
7332685607262xxxxxx​
云机 ID。​
Status​
Integer​
1​
云机状态。取值如下:​
  • 0:初始化​
  • 1:正常​
  • 2:退订中​
  • 3:异常​
  • 4:重置中​
  • 5:重启中​
Region​
String​
cn-north​
云机所在大区 ID。包含以下取值:​
  • cn-north:中国大陆华北​
  • cn-south:中国大陆华南​
  • cn-east:中国大陆华东​
  • cn-middle:中国大陆华中​
  • cn-southwest:中国大陆西南​
  • cn-hongkong-pop中国香港​
Dc​
String​
tjtj-xxxxxx​
云机所在机房。​
ConfigurationCode​
String​
elementary​
云机上的实例规格 ID。更多实例规格详情参看本地存储实例规格列表。​
ConfigurationName​
String​
低配型​
云机上的实例规格名称。​
ServerTypeCode​
String​
g2.8c12g​
云机规格。更多云机规格详情参看本地存储云机规格列表。​
PodIdList​
Array of String​
["7337159054625xxxxxx","7337159054626xxxxxx"]​
云机上的实例 ID 列表。​
ResourceSetId​
String​
Android_cloud7332703111729xxxxxx​
云机绑定的资源组 ID。​
ChargeType​
String​
node_pre_monthly​
云机的计费类型。取值如下:​
  • pod_pre_monthly:实例预付费月结​
  • pod_post_daily:实例后付费日结​
  • host_pre_monthly:云机预付费月结​
CreateAt​
Long​
1707278000​
云机的创建时间,Unix 时间戳,单位为秒。​
ExpireAt​
Long​
1707278000​
云机的到期时间,Unix 时间戳,单位为秒。​
PodNumOnHost​
Integer​
5​
云机上已创建的实例数量。​
PodNumAvailable​
Integer​
6​
云机上总共可以创建的实例数量。​
VolcRegion​
String​
inner​
资源所在物理区域,包含以下取值:​
  • inner:中国大陆​
  • cn-hongkong-pop:中国香港​
AuthorityExpireTime​
Long​
0​
云机运维授权过期时间,unix 时间戳,若为 0 则代表未授权。​
AuthorityStatus​
Integer​
1​
云机运维授权状态:​
  • 1:未授权;​
  • 2:已授权。​
ZoneId​
String​
zjwz-ctcucm-03​
云机所在的区域 ID,用于标识云机部署的具体区域位置。​
​
请求示例​
​
GET https://open.volcengineapi.com?Action=DetailHost&Version=2025-05-01&ProductId=1749281594201xxxxxx&HostId=7332685607262xxxxxx​
​
返回示例​
​
{​
"ResponseMetadata": {​
"Action": "DetailHost",​
"Region": "cn-north-1",​
"Service": "ACEP",​
"Version": "2025-05-01",​
"RequestId": "20230604110420****100232280022D31"​
},​
"Result": {​
"AccountId": "2100xxxxxx",​
"ProductId": "1749281594201xxxxxx",​
"HostId": "7332685607262xxxxxx",​
"Status": 1,​
"Region": "cn-north",​
"Dc": "tjtj-xxxxxx",​
"ConfigurationCode": "elementary",​
"ConfigurationName": "低配型",​
"ServerTypeCode": "g2.8c12g",​
"PodIdList": [​
"7337159054625xxxxxx",​
"7337159054626xxxxxx"​
],​
"ResourceSetId": "Android_cloud7332703111729xxxxxx",​
"ChargeType": "node_pre_monthly",​
"CreateAt": 1707278000,​
"ExpireAt": 1707278000,​
"PodNumOnHost": 5,​
"PodNumAvailable": 6,​
"VolcRegion": "inner",​
"AuthorityExpireTime": 0,​
"AuthorityStatus": 1,​
"ZoneId": "zjwz-ctcucm-03"​
}​
}​
​
错误码​
您可访问 公共错误码,获取更多错误码信息。​
​
最近更新时间:2026.06.12 16:17:41
这个页面对您有帮助吗?
有用
有用
无用
无用