文档

ListInstances - 获取云手机列表

更新时间:

查询云手机列表接口。

接口说明

  • 此接口只支持 NextToken 查询方式
  • 返回结果按照云手机创建时间顺序正序返回
  • 通过 NextToken 设置查询凭证(Token),其取值是上一次调用 ListInstances 返回的 NextToken 参数值,再通过 MaxResults 设置单页查询的最大条目数。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudphone:ListInstancesRead
  • Instance
    acs:cloudphone:{#regionId}:{#accountId}:instance/*
  • Instance
    acs:cloudphone:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

云手机实例所在的地域。

cn-hangzhou
InstanceIdarray

云手机实例 ID,N 的取值范围:1~100。

string

云手机实例 ID

cp-xxxxxxxxxx
InstanceNamestring

云手机实例名称。

phone
Statusstring

实例状态。取值范围:

  • Pending:创建中
  • Running:运行中
  • Starting:启动中
  • Stopping:停止中
  • Stopped:已停止
  • Expired: 已过期
Running
KeyPairNamestring

密钥对名称。必须保持名称唯一性。 长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以 http:// 和 https:// 开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

testKeyPairName
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值,初次调用无需配置。

ADBAAdDWBF2****
MaxResultsinteger

返回的最大数,取值范围:1~100。

50
ZoneIdstring

云手机所在可用区。

cn-hangzhou-i
Resolutionstring

云手机使用的分辨率。

1920*1080
ChargeTypestring

付费类型,支持预付费和后付费,可选值:

  • PrePaid 预付费
  • PostPaid 后付费
PostPaid
InstanceTypestring

实例规格。

ecp.ce.large
ImageIdstring

镜像 ID。

cpm-xxxxxxxxx
ShowWebRtcTokenboolean

查询结果中是否返回 webRtcToken。

false
Tagobject []

根据指定的标签筛选实例。

Keystring

实例的标签键。N 的取值范围为 1~20。

TestKey
Valuestring

实例的标签值。N 的取值范围为 1~20。

TestValue
Filterobject []

查询资源时的筛选条件列表。

Keystring

查询实例时的筛选键。取值范围:

  • 当该参数取值为 ExpiredStartTime 时,可以查询指定过期时间点(Filter.N.Value)后创建的资源信息。

  • 当该参数取值为 ExpiredEndTime 时,可以查询在指定过期时间点(Filter.N.Value)前创建的资源信息。

  • 当该参数取值为 CreationStartTime 时,可以查询在指定创建时间点(Filter.N.Value)后创建的资源信息。

  • 当该参数取值为 CreationEndTime 时,可以查询在指定过期时间点(Filter.N.Value)前创建的资源信息。

ExpiredStartTime
Valuestring

查询实例时的筛选值。指定该参数时必须同时指定 Filter.N.Key 参数,格式为:yyyy-MM-ddTHH:mmZ,采用 UTC+0 时区。

2023-11-05T00:00Z

返回参数

名称类型描述示例值
object
NextTokenstring

返回下一页的查询凭证。

ADBAAdDWBF2****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

实例总数。

3
MaxResultsinteger

返回的最大数,取值范围:1~100。

50
Instancesobject []

实例列表。

Statusstring

实例状态。取值范围:

  • Pending:创建中
  • Running:运行中
  • Starting:启动中
  • Stopping:停止中
  • Stopped:已停止
Running
CreationTimestring

镜像创建时间,采用 ISO 8601 格式。

2021-01-01T01:07Z
KeyPairNamestring

实例密钥对名称。

testKeyPairName
SecurityGroupIdstring

安全组 ID,与 ECS 使用相同的安全组。

sg-xxxxx
AutoRenewboolean

是否自动续费,只对预付费实例生效。

false
ChargeTypestring

实例付费类型。

PostPaid
OsNamestring

操作系统的中文显示名称。

Android 9.0
InstanceIdstring

实例 ID。

cp-xxxxxxxxxxx
InstanceTypestring

实例规格。

ecp.ce.large
RegionIdstring

云手机地域。

cn-hangzhou
Descriptionstring

实例描述。

testDescription
ExpiredTimestring

预付费实例到期时间。

2021-12-21T22:00Z
InstanceNamestring

实例名称。

testInstanceName
ZoneIdstring

可用区。

cn-hangzhou-i
Resolutionstring

云手机实例选用的分辨率。

1920*1080
ImageIdstring

镜像 ID。

cpm-xxxxxxxx
OsNameEnstring

操作系统的英文显示名称。

Android 9.0
VpcAttributesobject

实例的 VPC 信息。

PrivateIpAddressstring

私网 IP

192.168.0.85
VSwitchIdstring

虚拟交换机 ID

vsw-bp1kbwqxxxxx
EipAddressobject

实例的弹性公网 IP 信息。

InternetChargeTypestring

EIP 付费类型。

PayByTraffic
IpAddressstring

EIP 的地址。

120.55.XX.XX
Bandwidthinteger

EIP 带宽值。

2
AllocationIdstring

云手机实例 EIP 的 ID。

eip-bp1vctqgcoi6i9nxxxxxx
WebRtcTokenstring

webRtcToken 信息

eDeybrh74h34***
Tagsobject []

实例的标签集合。

Keystring

实例的标签键。

TestKey
Valuestring

实例的标签值。

TestValue

示例

正常返回示例

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-08OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Filter
2022-02-18OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ShowWebRtcToken
出参OpenAPI 返回结构发生变更
2021-09-22OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ZoneId
    新增入参:Resolution
    新增入参:ChargeType
    新增入参:InstanceType
    新增入参:ImageId
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)