You need to enable JavaScript to run this app.
导航
云手机
  • 文档首页
    • /云手机/服务端 OpenAPI 文档/实例管理/查询实例详情 DetailPod
查询实例详情 DetailPod
最近更新时间：2025.07.24 19:45:55首次发布时间：2024.03.04 19:40:01
复制全文
我的收藏
有用
有用
无用
无用

查询单个指定实例的详细信息。

使用说明

本接口仅可查询单个实例的详细信息。如需查询多个实例信息，请使用 ListPod 接口。

注意事项

本接口的单用户 QPS 限制为 200 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DetailPod接口名称。当前 API 的名称为 DetailPod。
VersionString是2023-10-30接口版本。当前 API 的版本为 2023-10-30。
ProductIdString是163571455047xxxx实例所归属的业务 ID。可登录云手机控制台，在已创建的业务卡片中获取。
PodIdString是7235890322201xxxxxx实例 ID，用于指定想要查询的目标实例。

返回参数

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

参数类型示例值描述
ProductIdString1591495366954xxxxxx实例归属业务 ID。
PodIdString7235890322201xxxxxx实例 ID。
PodNameString7235890322201xxxxxx实例名称。
ImageIdStringimg-66176xxx实例使用的镜像 ID。
ImageNameString平台公共镜像AOSP11(06-20)实例使用的镜像名称。
TagObject of Tag-与实例绑定的标签信息。
DcInfoObject of PodDc-实例归属机房信息。
ConfigurationObject of Configuration-实例套餐规格信息。
DataSizeString16Gi存储总量。
DataSizeUsedString15.514Gi存储用量。

DisplayLayoutId

String

single-display-landscape

屏幕布局 ID。系统屏幕布局包含以下取值：

  • single-display-landscape：1080p 横屏，分辨率 1920*1080 像素，像素密度 320 dpi，帧率 60fps；
  • single-display-portrait：1080p 竖屏，分辨率 1080*1920 像素，像素密度 320 dpi，帧率 60fps；
  • single-display-portrait-720p：高清竖屏，分辨率 720*1080 像素，像素密度 320 dpi，帧率 30fps。

DisplayStatus

JSON Map

{"key": value}

屏幕推流状态。

  • key：String 类型，屏幕 ID；
  • value：Integer 类型，推流状态，具体状态见Status 定义。
AdbString123.112.34ADB 地址，返回空值表示未开启 ADB。

AdbStatus

Integer

0

ADB 开关状态。包含以下取值：

  • 0：关闭
  • 1：开启
AdbExpireTimeLong0ADB 过期时间。小于或等于 0 表示无过期时间。

Online

Integer

1

实例运行状态。包含以下取值：

  • 0：开机中
  • 1：运行中
  • 2：已关机
  • 3：关机中
  • 4：重启中
IntranetIPString10.xx.xxx.xx实例的内网 IP。

StreamStatus

Integer

2

实例推流状态。包含以下取值：

UpBandwidthLimitInteger0实例上行带宽上限，单位为 Mbps。0 表示未设置限速。
DownBandwidthLimitInteger0实例下行带宽上限，单位为 Mbps。0 表示未设置限速。

AospVersion

String

11

实例镜像版本。包含以下取值：

  • 10：AOSP 10
  • 11：AOSP 11
CreateAtLong1684740971实例创建时间，Unix 时间戳。

AuthorityStatus

Integer

2

实例授权运维状态。包含以下取值：

  • 1：未授权
  • 2：已授权
AuthorityExpireTimeLong0实例授权运维过期时间。
PortMappingRuleListArray of PortMappingRule-端口映射列表。
HostIdString7235890389201xxxxxx云机 ID。
ServerTypeCodeStringg2.8c12g云机规格，详情参看本地存储云机规格列表。
DNSIdStringdns-7417778232776252204实例关联的自定义 DNS 规则 ID。

ArchiveStatus

Integer

0

实例的备份/还原状态，包含以下取值：

  • -2：还原失败；
  • -1：备份失败；
  • 0：正常状态；
  • 1：备份中；
  • 2：备份完成；
  • 3：还原中；
  • 5：备份排队中；
  • 6：还原排队中；
  • 7：备份取消中；
  • 8：还原取消中。

Tag

参数类型示例值描述
TagIdStringtag01标签 ID。
PodNumLong1标签关联的实例数量。
TagDescStringtag01标签描述。
TagNameString标签01标签名称。
ProductIdString1591495366954xxxxxx业务 ID。

PodDc

参数类型示例值描述
DcStringgdsz-ctcucm-01-1机房 ID。

Isp

Integer

7

运营商。包含以下取值：

  • 1：中国移动
  • 2：中国联通
  • 4：中国电信
  • 7：移动&联通&电信（三线）
  • 8：BGP
DcNameString广东深圳三线01-1机房名称。

Region

String

cn-south

机房所在大区。包含以下取值：

  • cn-north：中国大陆华北
  • cn-south：中国大陆华南
  • cn-east：中国大陆华东
  • cn-middle：中国大陆华中
  • cn-southwest：中国大陆西南
  • cn-hongkong-pop：中国香港
ZoneIdStringgdsz-ctcucm-01机房所在片区。

Configuration

参数类型示例值描述
ServerTypeCodeStringg2.8c12g云机规格，详情参看本地存储云机规格列表。
ConfigurationCodeStringbasic云手机实例规格 ID。
ConfigurationNameString基础型与 ConfigurationCode 相对应的实例规格名称。

ConfigurationType

Integer

1

云手机实例规格类型。包含以下取值：

  • 1：正式
  • 2：试用

PortMappingRule

参数类型示例值描述

Status

Integer

256

端口映射状态。包含以下取值：

  • 256：打开中
  • 257：打开完成
  • 512：关闭中
  • 513：关闭完成
  • 768：销毁中
  • 769：销毁完成

Protocol

String

tcp

端口映射策略。包含以下取值：

  • tcp
  • udp
PublicIpString111.xx.xxx.xx端口映射对应公网 IP。
PublicPortInteger6567端口映射对应公网端口。
SourcePortInteger5555端口映射源端口。
PortMappingRuleIdStringrule01对应端口映射规则 ID。
PublicPortInfoListArray of PublicPortInfo-公共端口信息列表。

PublicPortInfo

参数类型示例值描述

Isp

Integer

1

运营商。取值如下：

  • 1：中国移动
  • 2：中国联通
  • 4：中国电信
PublicIpString111.xx.xxx.xx公共 IP。
PublicPortInteger1094公共端口。

请求示例

GET https://open.volcengineapi.com?Action=DetailPod&Version=2023-10-30&ProductId=163571455047xxxx&PodId=163571455047xxxx

返回示例

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

错误码

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

附录

Status

状态码（十六进制）

状态码（十进制）

名称

说明

0x100

256

空闲

实例处于空闲状态

0x300

768

已使用

已使用（实例已经被分配给某个客户端使用）

0x303

771

推流中

实例正在推流

0x310

784

推流结束

客户端正常使用完毕

0x311

785

超时

客户端超时未加入释放

0x312

786

无操作

客户端无操作释放

0x315

789

异常

推流异常

0x316

790

异常

客户端异常退出

0x400

1024

故障

故障

0x408

1032

重置中

实例正在被重置

0x409

1033

重启中

实例正在被重启