【旧版】查询实例列表 ListPod--云手机-火山引擎

文档中心

立即注册

导航

【旧版】查询实例列表 ListPod

最近更新时间：2025.05.16 15:50:59首次发布时间：2024.03.04 19:40:01

查询指定业务下已创建的云手机实例的详细信息。支持单个实例查询、多个实例查询、全量实例查询，以及基于特定字段的筛选实例查询。

使用说明

如需查询单个实例的详细信息，请通过 PodId 参数指定实例 ID；如需查询多个实例的详细信息，请通过 PodIdList 参数指定实例列表；不指定任何实例 ID 时默认查询所有符合筛选条件（如有）的实例详情。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListPod&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListPod`	接口名称。当前 API 的名称为 `ListPod`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`163571455047xxxx`	业务 ID，用于指定想要查询的目标业务。可登录云手机控制台，在已创建的业务卡片中获取。
PodId	String	否	`7441102020708xxxxxx`	实例 ID。如需查询单个实例的详细信息，请通过本参数指定目标实例。
PodIdList	String	否	`7330243741xxx,733024374xxxx`	实例 ID 列表。如需查询多个实例的详细信息，请通过本参数指定目标实例列表。多个实例 ID 请以英文逗号 “,” 分隔。
ConfigurationCodeList	String	否	`ultimate`	云手机实例套餐规格 ID。使用本参数可以筛选出指定规格的云手机实例进行查询。多个规格 ID 请以英文逗号 “,” 分隔。当前业务下已购入的实例可选规格可以通过 ListPodResource 接口查询。更多规格信息参看本地存储实例规格列表或云盘存储实例规格列表。
RegionList	String	否	`cn-north`	实例归属机房所在的大区 ID。使用本参数可以筛选出指定大区的云手机实例进行查询。多个大区 ID 请以英文逗号 “,” 分隔。包含以下取值： `cn-north`：华北 `cn-south`：华南 `cn-east`：华东 `cn-middle`：华中 `cn-southwest`：西南
DcList	String	否	`gdsz-ctcucm-01-1,gdsz-ctcucm-01-2`	实例归属机房 ID。使用本参数可以筛选出指定机房的云手机实例进行查询。多个机房 ID 请以英文逗号 “,” 分隔。可通过调用 ListDc 接口获取。
TagIdList	String	否	`01,02`	标签 ID。使用本参数可以筛选出添加了指定标签的云手机实例进行查询。多个标签 ID 请以英文逗号 “,” 分隔。可通过调用 ListTag 接口获取。
OnlineList	String	否	`1`	实例运行状态。使用本参数可以筛选出指定运行状态的云手机实例进行查询。多个运行状态值请以英文逗号 “,” 分隔。包含以下取值： `0`：开机中 `1`：运行中 `2`：已关机 `3`：关机中 `4`：重启中
StreamStatusList	String	否	`1`	实例推流状态。使用本参数可以筛选出指定推流状态的云手机实例进行查询。多个推流状态值请以英文逗号 “,” 分隔。包含以下取值： `0`：空闲 `1`：推流中 `2`：就绪
AuthorityStatus	Integer	否	`1`	实例运维授权状态。使用本参数可以筛选出指定运维状态的云手机实例进行查询。包含以下取值： `1`：未授权 `2`：已授权
ZoneId	String	否	`gdsz-ctcucm-01`	实例归属机房所在片区 ID。使用本参数可以筛选出指定片区的云手机实例进行查询。可通过 ListDc 接口返回的 `Zone` 字段获取。
ServerTypeCode	String	否	`g2.8c12g`	云机规格。本地存储业务使用本参数可以筛选出指定规格云机上的云手机实例进行查询。云机规格详情参看本地存储云机规格列表。
HostId	String	否	`7235890389201xxxxxx`	云机 ID。本地存储业务使用本参数可以筛选出指定云机上的云手机实例进行查询。可通过 ListHost 接口获取。
DNSId	String	否	`dns-7417778232776xxxxxx`	DNS 规则 ID。关联了自定义 DNS 规则的实例，可使用本参数筛选出指定规则查询关联实例详情。
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Row	Array of Pod	`-`	列表行信息。
Total	Long	`1`	总数。

Pod

参数	类型	示例值	描述
ProductId	String	`1591495366954xxxxxx`	实例归属业务 ID。
PodId	String	`7270379583097xxxxxx`	实例 ID。
PodName	String	`7270379583097xxxxxx`	实例名称。
ImageId	String	`img-114663xxx`	实例使用的镜像 ID。
ImageName	String	`平台公共镜像AOSP11(06-20)`	实例使用的镜像名称。
Tag	Object of Tag	`-`	与实例绑定的标签信息。
DcInfo	Object of PodDc	`-`	实例归属机房信息。
Configuration	Object of Configuration	`-`	实例套餐规格信息。
DataSize	String	`4Gi`	存储总量。
DataSizeUsed	String	`0.582Gi`	存储用量。
DisplayLayoutId	String	`single-display-landscape`	屏幕布局 ID。系统屏幕布局包含以下取值： `single-display-landscape`：1080p 横屏，分辨率 19201080 像素，像素密度 320 dpi，帧率 60fps； `single-display-portrait`：1080p 竖屏，分辨率 10801920 像素，像素密度 320 dpi，帧率 60fps； `single-display-portrait-720p`：高清竖屏，分辨率 720*1080 像素，像素密度 320 dpi，帧率 30fps。
Adb	String	`123.33.123.12:1234`	ADB 地址，返回空值表示未开启 ADB。
AdbStatus	Integer	`0`	ADB 开关状态。包含以下取值： `0`：关闭 `1`：开启
AdbExpireTime	Long	`0`	ADB 过期时间。小于或等于 `0` 表示无过期时间。
Online	Integer	`1`	实例运行状态。包含以下取值： `0`：开机中 `1`：运行中 `2`：已关机 `3`：关机中 `4`：重启中
IntranetIP	String	`10.xx.xxx.xx`	实例的内网 IP。
StreamStatus	Integer	`1`	实例推流状态。包含以下取值： `0`：空闲 `1`：推流中 `2`：就绪
UpBandwidthLimit	Integer	`0`	实例上行带宽上限，单位为 Mbps。0 表示未设置限速。
DownBandwidthLimit	Integer	`0`	实例下行带宽上限，单位为 Mbps。0 表示未设置限速。
AospVersion	String	`11`	实例镜像版本。包含以下取值： `10`：AOSP 10 `11`：AOSP 11
CreateAt	Long	`1692000000`	实例创建时间，Unix 时间戳。
AuthorityStatus	Integer	`1`	实例授权运维状态。包含以下取值： `1`：未授权 `2`：已授权
AuthorityExpireTime	Long	`0`	实例授权运维过期时间。
PortMappingRuleList	Array of PortMappingRule	`-`	端口映射列表。
HostId	String	`host-7337959478131xxxxxx`	云机 ID。
ServerTypeCode	String	`g2.8c12g`	云机规格。
DNSId	String	`dns-7417778232776xxxxxx`	实例关联的自定义 DNS 规则 ID。

Tag

参数	类型	示例值	描述
ProductId	String	`1591495366954xxxxxx`	业务 ID。
TagId	String	`tag01`	标签 ID。
PodNum	Long	`1`	标签关联的实例数量。
TagDesc	String	`tag01`	标签描述。
TagName	String	`标签01`	标签名称。

PodDc

参数	类型	示例值	描述
Dc	String	`gdsz-ctcucm-01-1`	机房 ID。
DcName	String	`广东深圳三线01-1`	机房名称。
Region	String	`cn-south`	机房所在大区。包含以下取值： `cn-north`：中国大陆华北 `cn-south`：中国大陆华南 `cn-east`：中国大陆华东 `cn-middle`：中国大陆华中 `cn-southwest`：中国大陆西南 `cn-hongkong-pop`：中国香港
Isp	Integer	`7`	运营商。包含以下取值： `1`：中国移动 `2`：中国联通 `4`：中国电信 `7`：移动&联通&电信（三线） `8`：BGP
ZoneId	String	`gdsz-ctcucm-01`	机房所在片区。

Configuration

参数	类型	示例值	描述
ConfigurationCode	String	`basic`	云手机实例规格 ID。
ConfigurationName	String	`基础型`	与 `ConfigurationCode` 相对应的实例规格名称。
ConfigurationType	Integer	`1`	云手机实例规格类型。包含以下取值： `1`：正式 `2`：试用
ServerTypeCode	String	`g2.8c12g`	云机规格，详情参看本地存储云机规格列表。

PortMappingRule

参数	类型	示例值	描述
Status	Integer	`256`	端口映射状态。包含以下取值： `256`：打开中 `257`：打开完成 `512`：关闭中 `513`：关闭完成 `768`：销毁中 `769`：销毁完成
Protocol	String	`tcp`	端口映射策略。包含以下取值： `tcp` `udp`
PublicIp	String	`111.xx.xxx.xx`	端口映射对应公网 IP。
PublicPort	Integer	`6567`	端口映射对应公网端口。
SourcePort	Integer	`5555`	端口映射源端口。
PortMappingRuleId	String	`rule01`	对应端口映射规则 ID。
PublicPortInfoList	Array of PublicPortInfo	`-`	公共端口信息列表。

PublicPortInfo

参数类型示例值描述

参数	类型	示例值	描述
Isp	Integer	`1`	运营商。取值如下： `1`：中国移动 `2`：中国联通 `4`：中国电信
PublicIp	String	`111.xx.xxx.xx`	公共 IP。
PublicPort	Integer	`1094`	公共端口。

Isp

Integer

1

运营商。取值如下：

1：中国移动
2：中国联通
4：中国电信

PublicIp String 111.xx.xxx.xx 公共 IP。

PublicPort Integer 1094 公共端口。

请求示例

GET https://open.volcengineapi.com?Action=ListPod&Version=2023-10-30&ProductId=1591495366954xxxxxx&ConfigurationCodeList=basic&OnlineList=1&StreamStatusList=1&ServerTypeCode=g2.8c12g&HostId=7337959478131xxxxxx&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104***232280022D31",
        "Action": "ListPod",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "Row": [
            {
                "ProductId": "1591495366954xxxxxx",
                "PodId": "7270379583097xxxxxx",
                "PodName": "7270379583097xxxxxx",
                "ImageId": "img-114663xxx",
                "ImageName": "平台公共镜像AOSP11(06-20)",
                "Tag": {
                    "TagId": "tag01",
                    "TagName": "标签01",
                    "PodNum": 0,
                    "TagDesc": "tag01",
                    "ProductId": "7270379583097xxxxxx"
                },
                "DcInfo": {
                    "Dc": "gdsz-ctcucm-01-1",
                    "DcName": "广东深圳三线01-1",
                    "Region": "cn-south",
                    "Isp": 7,
                    "ZoneId": "gdsz-ctcucm-01"
                },
                "Configuration": {
                    "ConfigurationName": "基础型",
                    "ConfigurationCode": "basic",
                    "ConfigurationType": 1,
                    "ServerTypeCode": "g2.8c12g",
                    "CpuCore": 2,
                    "Memory": 1024
                },
                "DataSize": "4Gi",
                "DataSizeUsed": "0.582Gi",
                "DisplayLayoutId": "single-display-landscape",
                "Adb": "",
                "AdbStatus": 0,
                "AdbExpireTime": 0,
                "Online": 1,
                "IntranetIP": "10.xx.xxx.xx",
                "StreamStatus": 1,
                "UpBandwidthLimit": 0,
                "DownBandwidthLimit": 0,
                "AospVersion": "11",
                "CreateAt": 1692767767,
                "AuthorityExpireTime": 0,
                "AuthorityStatus": 1,
                "PortMappingRuleList": [
                    {
                        "PublicPort": 6567,
                        "PublicIp": "10.xx.xxx.xx",
                        "SourcePort": 5555,
                        "PortMappingRuleId": "rule01",
                        "Protocol": "tcp",
                        "Status": 1
                    }
                ],
                "HostId": "7337959478131xxxxxx",
                "ServerTypeCode": "g2.8c12g",
                "DNSId": "dns-7417778232776xxxxxx"
            }
        ],
        "Total": 1
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。