查询云手机列表接口。
接口说明
- 此接口只支持 NextToken 查询方式
- 返回结果按照云手机创建时间顺序正序返回
- 通过 NextToken 设置查询凭证（Token），其取值是上一次调用 ListInstances 返回的 NextToken 参数值，再通过 MaxResults 设置单页查询的最大条目数。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cloudphone:ListInstances | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 云手机实例所在的地域。 | cn-hangzhou |
| InstanceId | array | 否 | 云手机实例 ID，N 的取值范围：1~100。 | |
| string | 否 | 云手机实例 ID | cp-xxxxxxxxxx | |
| InstanceName | string | 否 | 云手机实例名称。 | phone |
| Status | string | 否 | 实例状态。取值范围：
| Running |
| KeyPairName | string | 否 | 密钥对名称。必须保持名称唯一性。 长度为 2~128 个英文或中文字符。必须以大小字母或中文开头，不能以 http:// 和 https:// 开头。可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。 | testKeyPairName |
| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值，初次调用无需配置。 | ADBAAdDWBF2**** |
| MaxResults | integer | 否 | 返回的最大数，取值范围：1~100。 | 50 |
| ZoneId | string | 否 | 云手机所在可用区。 | cn-hangzhou-i |
| Resolution | string | 否 | 云手机使用的分辨率。 | 1920*1080 |
| ChargeType | string | 否 | 付费类型，支持预付费和后付费，可选值：
| PostPaid |
| InstanceType | string | 否 | 实例规格。 | ecp.ce.large |
| ImageId | string | 否 | 镜像 ID。 | cpm-xxxxxxxxx |
| ShowWebRtcToken | boolean | 否 | 查询结果中是否返回 webRtcToken。 | false |
| Tag | object [] | 否 | 根据指定的标签筛选实例。 | |
| Key | string | 否 | 实例的标签键。N 的取值范围为 1~20。 | TestKey |
| Value | string | 否 | 实例的标签值。N 的取值范围为 1~20。 | TestValue |
| Filter | object [] | 否 | 查询资源时的筛选条件列表。 | |
| Key | string | 否 | 查询实例时的筛选键。取值范围：
| ExpiredStartTime |
| Value | string | 否 | 查询实例时的筛选值。指定该参数时必须同时指定 Filter.N.Key 参数，格式为:yyyy-MM-ddTHH:mmZ，采用 UTC+0 时区。 | 2023-11-05T00:00Z |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "ADBAAdDWBF2****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 3,
"MaxResults": 50,
"Instances": {
"Instance": [
{
"Status": "Running",
"CreationTime": "2021-01-01T01:07Z",
"KeyPairName": "testKeyPairName",
"SecurityGroupId": "sg-xxxxx",
"AutoRenew": false,
"ChargeType": "PostPaid",
"OsName": "Android 9.0",
"InstanceId": "cp-xxxxxxxxxxx",
"InstanceType": "ecp.ce.large",
"RegionId": "cn-hangzhou",
"Description": "testDescription",
"ExpiredTime": "2021-12-21T22:00Z",
"InstanceName": "testInstanceName",
"ZoneId": "cn-hangzhou-i",
"Resolution": "1920*1080",
"ImageId": "cpm-xxxxxxxx",
"OsNameEn": "Android 9.0",
"VpcAttributes": {
"PrivateIpAddress": "192.168.0.85",
"VSwitchId": "vsw-bp1kbwqxxxxx"
},
"EipAddress": {
"InternetChargeType": "PayByTraffic",
"IpAddress": "120.55.XX.XX",
"Bandwidth": 2,
"AllocationId": "eip-bp1vctqgcoi6i9nxxxxxx"
},
"WebRtcToken": "eDeybrh74h34***",
"Tags": {
"Tag": [
{
"Key": "TestKey",
"Value": "TestValue"
}
]
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-11-08 | OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
| 2022-02-18 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
| 2021-09-22 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||||
|