查询实例详情 DetailPod--云手机-火山引擎

文档中心

立即注册

云手机

实例管理

查询实例详情 DetailPod

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

使用说明

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

注意事项

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

请求说明

请求地址：https://open.volcengineapi.com?Action=DetailPod&Version=2025-05-01

请求参数

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

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

返回参数

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

参数	类型	示例值	描述
ProductId	String	1591495366954xxxxxx	实例归属业务 ID。
PodId	String	7235890322201xxxxxx	实例 ID。
PodName	String	7235890322201xxxxxx	实例名称。
ImageId	String	66176xxx	实例使用的镜像 ID。
ImageName	String	平台公共镜像AOSP11(06-20)	实例使用的镜像名称。
Tag	Object of Tag	-	与实例绑定的标签信息。
DcInfo	Object of PodDc	-	实例归属机房信息。
Configuration	Object of Configuration	-	实例套餐规格信息。
DataSize	String	16Gi	存储总量。
DataSizeUsed	String	15.514Gi	存储用量。
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。
DisplayStatus	JSON Map	{"key": value}	屏幕推流状态。 `key`：String 类型，屏幕 ID； `value`：Integer 类型，推流状态，具体状态见Status 定义。
Adb	String	123.112.34	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	2	实例推流状态。包含以下取值： `0`：空闲 `1`：推流中 `2`：就绪更多相关说明参看实例推流状态说明。
UpBandwidthLimit	Integer	0	实例上行带宽上限，单位为 Mbps。0 表示未设置限速。
DownBandwidthLimit	Integer	0	实例下行带宽上限，单位为 Mbps。0 表示未设置限速。
AospVersion	String	11	实例镜像版本。包含以下取值： `10`：AOSP 10 `11`：AOSP 11
CreateAt	Long	1684740971	实例创建时间，Unix 时间戳。
AuthorityExpireTime	Long	2	实例授权运维状态。包含以下取值： `1`：未授权 `2`：已授权
AuthorityStatus	Integer	0	实例授权运维过期时间。
PortMappingRuleList	Array of PortMappingRule	-	端口映射列表。
HostId	String	7235890389201xxxxxx	云机 ID。
ServerTypeCode	String	g2.8c12g	云机规格，详情参看本地存储云机规格列表。
DNSId	String	dns-7417778232776252204	实例关联的自定义 DNS 规则 ID。
ArchiveStatus	Integer	0	实例的备份/还原状态，包含以下取值： `-2`：还原失败； `-1`：备份失败； `0`：正常状态； `1`：备份中； `2`：备份完成； `3`：还原中； `5`：备份排队中； `6`：还原排队中； `7`：备份取消中； `8`：还原取消中。
CustomRouteId	String	cr-1234****	自定义路由 ID。

Tag

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

PodDc

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

Configuration

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

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：中国移动
2：中国联通
4：中国电信

PublicIp

String

111.xx.xxx.xx

公共 IP。

PublicPort

Integer

1094

公共端口。

请求示例

https://open.volcengineapi.com?Action=DetailPod&Version=2025-05-01&ProductId=163571455047xxxx&PodId=7235890322201xxxxxx
{
    "ProductId": "163571455047xxxx",
    "PodId": "7235890322201xxxxxx"
}

返回示例

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

错误码

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

Status

状态码（十六进制）	状态码（十进制）	名称	说明
0x100	256	空闲	实例处于空闲状态
0x300	768	已使用	已使用（实例已经被分配给某个客户端使用）
0x303	771	推流中	实例正在推流
0x310	784	推流结束	客户端正常使用完毕
0x311	785	超时	客户端超时未加入释放
0x312	786	无操作	客户端无操作释放
0x315	789	异常	推流异常
0x316	790	异常	客户端异常退出
0x400	1024	故障	故障
0x408	1032	重置中	实例正在被重置
0x409	1033	重启中	实例正在被重启

最近更新时间：2026.01.28 16:48:46

这个页面对您有帮助吗？

有用

无用

云手机

使用说明 #

注意事项 #

请求说明 #

请求参数 #

返回参数 #

Tag #

PodDc #

Configuration #

PortMappingRule #

PublicPortInfo #

请求示例 #

返回示例 #

错误码 #

Status #