文档反馈
问问助手查询指定业务下已创建的云手机实例的详细信息。支持单个实例查询、多个实例查询、全量实例查询，以及基于特定字段的筛选实例查询。
使用说明
如需查询指定实例的详细信息，请通过 PodIdList 参数传入目标实例 ID；不指定任何实例 ID 时默认查询所有符合筛选条件（如有）的实例详情。
注意事项
本接口的单用户 QPS 限制为 30 次/秒。超过限制，API 调用会被限流。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com?Action=ListPod&Version=2025-05-01
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListPod | 接口名称。当前 API 的名称为 ListPod。 |
| Version | String | 是 | 2025-05-01 | 接口版本。当前 API 的版本为 2025-05-01。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ProductId | String | 是 | 1635714550****** | 业务 ID，用于指定想要查询的目标业务。可登录云手机控制台，在已创建的业务卡片中获取。 |
| PodIdList | Array of String | 否 | ["7294157141458******", "7294107154305******"] | 实例 ID 列表。如需查询指定实例的详细信息，请通过本参数设置目标实例 ID 列表。最多支持传入 100 个 ID。 |
ConfigurationCodeList | Array of String | 否 |
| 云手机实例套餐规格 ID。使用本参数可以筛选出指定规格的云手机实例进行查询。 |
RegionList | Array of String | 否 |
| 实例归属机房所在的大区 ID。使用本参数可以筛选出指定大区的云手机实例进行查询。包含以下取值：
|
| DcList | Array of String | 否 | ["gdsz-ctcucm-01-1", "gdsz-ctcucm-01-2"] | 实例归属机房 ID。使用本参数可以筛选出指定机房的云手机实例进行查询。 |
TagIdList | Array of String | 否 |
| 标签 ID。使用本参数可以筛选出添加了指定标签的云手机实例进行查询。 |
OnlineList | Array of Integer | 否 |
| 实例运行状态。使用本参数可以筛选出指定运行状态的云手机实例进行查询。包含以下取值：
|
StreamStatusList | Array of Integer | 否 |
| 实例推流状态。使用本参数可以筛选出指定推流状态的云手机实例进行查询。包含以下取值：
|
AuthorityStatus | Integer | 否 |
| 实例运维授权状态。使用本参数可以筛选出指定运维状态的云手机实例进行查询。包含以下取值：
|
ZoneId | String | 否 |
| 实例归属机房所在片区 ID。使用本参数可以筛选出指定片区的云手机实例进行查询。 |
| ServerTypeCode | String | 否 | g2.8c12g | 云机规格。本地存储业务可以使用本参数筛选指定规格云机上的云手机实例进行查询。云机规格详情参看本地存储云机规格列表。 |
| HostId | String | 否 | 7235890389201****** | 云机 ID。本地存储业务可以使用本参数筛选出指定云机上的云手机实例进行查询。可通过 ListHost接口获取。 |
| DNSId | String | 否 | dns-7417778232776****** | DNS 规则 ID。关联了自定义 DNS 规则的实例，可使用本参数筛选出指定规则查询关联实例详情。 |
| PodName | String | 否 | pod_name | 实例名称，可以根据实例名称精确查找。 |
ArchiveStatus | Integer | 否 |
| 实例备份/还原状态。本地存储业务若已调用 BackupPod 或 RestorePod 接口对实例执行备份还原操作，使用本参数可以筛选出对应状态的云手机实例进行查询。取值如下：
|
| MaxResults | Integer | 否 | 10 | 分页查询时用于设置每页返回的条目数。最大值为 100，默认值为 10。 |
NextToken | String | 否 |
| 分页查询凭证，用于标记查询数据的起始位置。
注意
|
返回参数
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Row | Array of Pod | - | 查询到的实例详细信息。 |
NextToken | String |
| 本次调用返回的查询凭证，若返回空置即表示该页为末页。 注意 NextToken 有效期为 2 小时，若下次请求时使用了过期凭证，则将从第一条数据开始重新查询。 |
Pod
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ProductId | String | 1635714550****** | 实例归属业务 ID。 |
| PodId | String | 7294157141458****** | 实例 ID。 |
| PodName | String | pod_name | 实例名称。 |
| ImageId | String | img-1146**** | 实例使用的镜像 ID。 |
| ImageName | String | 平台公共镜像AOSP11(06-20) | 实例使用的镜像名称。 |
| Tag | Object of PodTag | - | 实例绑定的标签信息。 |
| DcInfo | Object of PodDc | - | 实例归属的机房信息。 |
| Configuration | Object of Configuration | - | 实例套餐规格信息。 |
| DataSize | String | 4Gi | 实例设置的预占存储容量。 |
| DataSizeUsed | String | 0.582Gi | 实例实际占用的存储容量。 |
DisplayLayoutId | String |
| 屏幕布局 ID。系统屏幕布局包含以下取值：
|
| Adb | String | 123.0.0.1:1234 | ADB 地址，返回空值表示未开启 ADB。 |
AdbStatus | Integer |
| ADB 开关状态。包含以下取值：
|
| AdbExpireTime | Long | 0 | ADB 过期时间。小于或等于 0 表示无过期时间。 |
Online | Integer |
| 实例运行状态。包含以下取值：
|
| IntranetIP | String | 10.xx.xxx.xx | 实例的内网 IP。 |
StreamStatus | Integer |
| 实例推流状态。包含以下取值：
|
| UpBandwidthLimit | Integer | 0 | 实例上行带宽上限，单位为 Mbps。0 表示未设置限速。 |
| DownBandwidthLimit | Integer | 0 | 实例下行带宽上限，单位为 Mbps。0 表示未设置限速。 |
AospVersion | String |
| 实例镜像版本。包含以下取值：
|
| CreateAt | Long | 1692000000 | 实例创建时间，Unix 时间戳。 |
AuthorityStatus | Integer |
| 实例授权运维状态。包含以下取值：
|
| AuthorityExpireTime | Long | 0 | 实例授权运维过期时间。小于或等于 0 表示无过期时间。 |
| PortMappingRuleList | Array of PortMappingRule | - | 端口映射列表。 |
| HostId | String | host-7337959478131****** | 实例归属云机 ID。 |
| ServerTypeCode | String | g2.8c12g | 实例归属云机的规格。 |
| DNSId | String | dns-7417778232776****** | 实例关联的自定义 DNS 规则 ID。 |
ArchiveStatus | Integer | 实例的备份还原状态。取值如下：
|
PodTag
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TagId | String | tag01 | 标签 ID。 |
| TagDesc | String | tag01 | 标签描述。 |
| TagName | String | 标签01 | 标签名称。 |
PodDc
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Dc | String | gdsz-ctcucm-01-1 | 机房 ID。 |
| DcName | String | 广东深圳三线01-1 | 机房名称。 |
Isp | Integer |
| 运营商。包含以下取值：
|
Region | String |
| 机房所在大区。包含以下取值：
|
| ZoneId | String | gdsz-ctcucm-01 | 机房所在区域 ID。 |
Configuration
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ConfigurationCode | String | basic | 云手机实例规格 ID。 |
| ConfigurationName | String | 基础型 | 与 ConfigurationCode 相对应的实例规格名称。 |
ConfigurationType | Integer |
| 云手机实例规格类型。包含以下取值：
|
| ServerTypeCode | String | g2.8c12g | 云机规格，详情参看本地存储云机规格列表。 |
PortMappingRule
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Status | Integer |
| 端口映射状态。包含以下取值：
|
Protocol | String |
| 端口映射策略。包含以下取值：
|
| PublicIp | String | 111.xx.xxx.xx | 端口映射对应公网 IP。 |
| PublicPort | Integer | 6567 | 端口映射对应公网端口。 |
| SourcePort | Integer | 5555 | 端口映射源端口。 |
| PortMappingRuleId | String | rule01 | 对应端口映射规则 ID。 |
| PublicPortInfoList | Array of PublicPortInfo | - | 公共端口信息列表。 |
PublicPortInfo
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Isp | Integer |
| 运营商。取值如下：
|
| PublicIp | String | 111.xx.xxx.xx | 公共 IP。 |
| PublicPort | Integer | 1094 | 公共端口。 |
请求示例
POST https://open.volcengineapi.com?Action=ListPod&Version=2025-05-01 { "ProductId": "1635714550******", "ConfigurationCodeList": [ "ultimate" ], "RegionList": [ "cn-south" ], "DcList": [ "gdsz-ctcucm-01-1" ], "TagIdList": [ "01" ], "OnlineList": [ 1 ], "StreamStatusList": [ 1 ], "AuthorityStatus": 1, "ZoneId": "gdsz-ctcucm-01", "ServerTypeCode": "g2.8c12g", "HostId": "7235890389201******", "DNSId": "dns-7417778232776******", "MaxResults": 2 }
返回示例
{ "ResponseMetadata": { "Action": "ListPod", "Region": "cn-north-1", "RequestId": "20250513190839C****9421BF7714E5C97", "Service": "ACEP", "Version": "2025-05-01" }, "Result": { "Row": [ { "ProductId": "1635714550******", "PodId": "7294157141458******", "PodName": "7294157141458******", "ImageId": "img-3299****", "ImageName": "paas平台公共镜像AOSP10（2024-03-09）", "Tag": { "TagId": "tag01", "TagName": "tag01", "TagDesc": "标签01" }, "DcInfo": { "Dc": "gdsz-ctcucm-01-1", "DcName": "广东深圳三线-01-1", "Region": "cn-south", "Isp": 7, "ZoneId": "gdsz-ctcucm-01" }, "Configuration": { "ConfigurationCode": "ultimate", "ConfigurationName": "旗舰型", "ConfigurationType": 1, "ServerTypeCode": "g2.8c12g" }, "DataSize": "4Gi", "DataSizeUsed": "0.000Gi", "DisplayLayoutId": "single-display-portrait-720p", "Adb": "", "AdbStatus": 0, "AdbExpireTime": 0, "Online": 1, "IntranetIP": "", "StreamStatus": 2, "UpBandwidthLimit": 0, "DownBandwidthLimit": 0, "AospVersion": "10", "CreateAt": 1746794647, "AuthorityExpireTime": 0, "AuthorityStatus": 1, "PortMappingRuleList": [], "HostId": "7235890389201******", "ServerTypeCode": "g2.8c16g.basic", "DNSId": "dns-7417778232776******" }, { "ProductId": "1635714550******", "PodId": "7294107154305******", "PodName": "7294107154305******", "ImageId": "img-3299****", "ImageName": "paas平台公共镜像AOSP10（2024-03-09）", "Tag": { "TagId": "tag01", "TagName": "tag01", "TagDesc": "标签01" }, "DcInfo": { "Dc": "gdsz-ctcucm-01-1", "DcName": "广东深圳三线-01-1", "Region": "cn-south", "Isp": 7, "ZoneId": "gdsz-ctcucm-01" }, "Configuration": { "ConfigurationCode": "ultimate", "ConfigurationName": "旗舰型", "ConfigurationType": 1, "ServerTypeCode": "g2.8c12g" }, "DataSize": "4Gi", "DataSizeUsed": "0.653Gi", "DisplayLayoutId": "single-display-portrait-720p", "Adb": "", "AdbStatus": 0, "AdbExpireTime": 0, "Online": 1, "IntranetIP": "10.xx.xx.245", "StreamStatus": 2, "UpBandwidthLimit": 0, "DownBandwidthLimit": 0, "AospVersion": "10", "CreateAt": 1746794601, "AuthorityExpireTime": 0, "AuthorityStatus": 1, "PortMappingRuleList": [], "HostId": "7235890389201******", "ServerTypeCode": "g2.8c16g.basic", "DNSId": "dns-7417778232776******" } ], "NextToken": "gzxPiseZCzGMaeiPQ5p0shP98t-r2pk7FNgd1g7jTWnDOOqs**********zPFDtDUZ402-ktMLjm7lK3U17k0hqZ48fl4QJiCceFij7cfAawYYXTs2l3CVPAgquKrXfB" } }
错误码
您可访问公共错误码，获取更多错误码信息。