You need to enable JavaScript to run this app.
导航
云手机
  • 文档首页
    • /云手机/服务端 OpenAPI 文档/历史版本/2022-08-01/【旧版】实例管理/【旧版】获取实例信息 ListPod
【旧版】获取实例信息 ListPod
最近更新时间：2024.06.17 19:39:46首次发布时间：2021.10.18 18:26:50
复制全文
我的收藏
有用
有用
无用
无用

查询指定业务的实例列表信息（如指定实例 ID，则仅查询指定实例的信息；如不指定实例 ID，则查询业务的所有实例）。

请求说明

  • 请求方式：GET
  • 请求地址：https://open.volcengineapi.com?Action=ListPod&Version=2022-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListPod接口名称。当前 API 的名称为 ListPod。
VersionString是2022-08-01接口版本。当前 API 的版本为 2022-08-01。
product_idString是163571455047xxxx实例所属业务 ID。可在「云手机控制台-业务管理-业务详情」中获取。
pod_idString否163571455047xxxx筛选条件，实例 ID。可通过调用 ListPod 接口获取。
pod_id_listArray of String否7330243741xxx,733024374xxxx筛选条件，实例 ID 列表。多个 ID 以英文逗号 , 分隔。

configuration_code_list

Array of String

否

ultimate,sample

筛选条件，套餐 ID 列表。可选项为：

  • ultimate：旗舰型
  • enhanced：加强型
  • common：通用型
  • sample：入门型
  • basic：基础型
  • elementary：低配型

region_list

Array of String

否

cn-north,cn-south

筛选条件，地区 ID 列表。可选项为：

  • cn-north：华北
  • cn-south：华南
  • cn-east：华东
  • cn-middle：华中
  • cn-southwest：西南

online_list

Array of String

否

0,1,2

筛选条件，实例运行状态列表。多个状态值以英文逗号 , 分隔。可选项为：

  • 0：开机中
  • 1：开机完成
  • 2：关机完成
  • 3：关机中
  • 4：重启中

stream_status_list

Array of String

否

0,1

筛选条件，实例推流状态列表。多个状态值以英文逗号 , 分隔。可选项为：

  • 0：空闲
  • 1：推流中
  • 2：就绪
tag_id_listString否7836293xxxxx,7973528231xxxx筛选条件，标签 ID 列表。可通过调用 ListTag 接口获取。
dc_listString否gdsz-xxxxx,gdsz-xxxxxx筛选条件，机房 ID 列表。多个机房 ID 列表以英文逗号 , 分隔。可通过调用 ListDc 接口获取。
zone_idString否gdsz-ctcucm-01筛选条件，区域 ID 列表。可通过调用 ListDc 接口获取，也就是返回的 zone 参数。
offsetInteger否0分页偏移量。
countInteger否10单页数量。

返回参数

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

参数类型示例值描述
totalInteger5查询结果总量。
rowArray of Row-查询到的实例信息列表，详细信息，参考 Pod 定义。

请求示例

GET https://open.volcengineapi.com?Action=ListPod&Version=2022-08-01&product_id=163571455047xxxx&pod_id=163575047xxxx

返回示例

{
    "ResponseMetadata": {
        "Action": "ListPod",
        "Region": "cn-north-1",
        "RequestId": "2024020211201***40E94DED4A20B5",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "row": [
            {
                "product_id": "174310***490040832",
                "pod_id": "7330195***6121014",
                "pod_name": "旗舰型",
                "image_id": "img-71848194",
                "image_name": "paas平台公共镜像AOSP10(2024-01-18)",
                "tag": {
                    "tag_id": "",
                    "tag_name": "",
                    "pod_num": 0,
                    "product_id": "",
                    "tag_desc": ""
                },
                "dc_info": {
                    "dc": "gdsz-ctcucm-01-xxxx",
                    "dc_name": "广东深圳三线01",
                    "region": "cn-south",
                    "isp": 7
                },
                "configuration": {
                    "configuration_code": "ultimate",
                    "configuration_name": "旗舰型",
                    "configuration_type": 1
                },
                "data_size": "16Gi",
                "data_size_used": "0.621Gi",
                "display_layout_id": "single-display-portrait",
                "display_status": {},
                "adb": "",
                "adb_status": 0,
                "adb_expire_time": 0,
                "online": 2,
                "intranet_ip": "",
                "stream_status": 2,
                "up_bandwidth_limit": 0,
                "down_bandwidth_limit": 0,
                "aosp_version": "10",
                "create_at": 1706694221,
                "authority_expire_time": 0,
                "authority_status": 1
            },
            {
                "product_id": "1743101***90040832",
                "pod_id": "733016919***092553",
                "pod_name": "加强型",
                "image_id": "img-71848194",
                "image_name": "paas平台公共镜像AOSP10(2024-01-18)",
                "tag": {
                    "tag_id": "",
                    "tag_name": "",
                    "pod_num": 0,
                    "product_id": "",
                    "tag_desc": ""
                },
                "dc_info": {
                    "dc": "gdsz-ctcucm-01-xxx",
                    "dc_name": "广东深圳三线01",
                    "region": "cn-south",
                    "isp": 7
                },
                "configuration": {
                    "configuration_code": "elementary",
                    "configuration_name": "低配型",
                    "configuration_type": 1
                },
                "data_size": "16Gi",
                "data_size_used": "0.000Gi",
                "display_layout_id": "single-display-portrait",
                "display_status": {},
                "adb": "",
                "adb_status": 0,
                "adb_expire_time": 0,
                "online": 2,
                "intranet_ip": "",
                "stream_status": 0,
                "up_bandwidth_limit": 0,
                "down_bandwidth_limit": 0,
                "aosp_version": "10",
                "create_at": 1706688102,
                "authority_expire_time": 0,
                "authority_status": 1
            },
            {
                "product_id": "174310***0040832",
                "pod_id": "73256314***0695562",
                "pod_name": "入门型1080",
                "image_id": "img-124885506",
                "image_name": "paas平台公共镜像AOSP10(2024-01-05)",
                "tag": {
                    "tag_id": "",
                    "tag_name": "",
                    "pod_num": 0,
                    "product_id": "",
                    "tag_desc": ""
                },
                "dc_info": {
                    "dc": "gdsz-ctcucm-01-xxx",
                    "dc_name": "广东深圳三线01",
                    "region": "cn-south",
                    "isp": 7
                },
                "configuration": {
                    "configuration_code": "sample",
                    "configuration_name": "入门型",
                    "configuration_type": 1
                },
                "data_size": "8Gi",
                "data_size_used": "0.748Gi",
                "display_layout_id": "single-display-portrait",
                "display_status": {},
                "adb": "",
                "adb_status": 0,
                "adb_expire_time": 0,
                "online": 1,
                "intranet_ip": "",
                "stream_status": 2,
                "up_bandwidth_limit": 0,
                "down_bandwidth_limit": 0,
                "aosp_version": "10",
                "create_at": 1705631598,
                "authority_expire_time": 0,
                "authority_status": 1
            },
            {
                "product_id": "1743101***90040832",
                "pod_id": "73253219***216420",
                "pod_name": "旗舰4g1080和60",
                "image_id": "img-124885506",
                "image_name": "paas平台公共镜像AOSP10(2024-01-05)",
                "tag": {
                    "tag_id": "",
                    "tag_name": "",
                    "pod_num": 0,
                    "product_id": "",
                    "tag_desc": ""
                },
                "dc_info": {
                    "dc": "gdsz-ctcucm-01-xxx",
                    "dc_name": "广东深圳三线01",
                    "region": "cn-south",
                    "isp": 7
                },
                "configuration": {
                    "configuration_code": "ultimate",
                    "configuration_name": "旗舰型",
                    "configuration_type": 1
                },
                "data_size": "8Gi",
                "data_size_used": "7.082Gi",
                "display_layout_id": "single-display-portrait",
                "display_status": {},
                "adb": "",
                "adb_status": 0,
                "adb_expire_time": 0,
                "online": 1,
                "intranet_ip": "",
                "stream_status": 2,
                "up_bandwidth_limit": 0,
                "down_bandwidth_limit": 0,
                "aosp_version": "10",
                "create_at": 1705559556,
                "authority_expire_time": 0,
                "authority_status": 1
            },
            {
                "product_id": "174310***90040832",
                "pod_id": "73205227***603465",
                "pod_name": "基础型",
                "image_id": "img-124885506",
                "image_name": "paas平台公共镜像AOSP10(2024-01-05)",
                "tag": {
                    "tag_id": "",
                    "tag_name": "",
                    "pod_num": 0,
                    "product_id": "",
                    "tag_desc": ""
                },
                "dc_info": {
                    "dc": "gdsz-ctcucm-01-xxx",
                    "dc_name": "广东深圳三线01",
                    "region": "cn-south",
                    "isp": 7
                },
                "configuration": {
                    "configuration_code": "common",
                    "configuration_name": "通用型",
                    "configuration_type": 1
                },
                "data_size": "256Gi",
                "data_size_used": "0.771Gi",
                "display_layout_id": "single-display-portrait-720p",
                "display_status": {},
                "adb": "",
                "adb_status": 0,
                "adb_expire_time": 0,
                "online": 1,
                "intranet_ip": "",
                "stream_status": 2,
                "up_bandwidth_limit": 0,
                "down_bandwidth_limit": 0,
                "aosp_version": "10",
                "create_at": 1704442096,
                "authority_expire_time": 0,
                "authority_status": 1
            }
        ],
        "total": 5
    }
}

错误码

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