DescribeAndroidInstances API で ECP インスタンスステータスを取得 - Cloud Phone - Alibaba Cloud -

クラウドフォンインスタンスの詳細を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceGroupId	string	任意	インスタンスグループ ID。	ag-25nt4kk9whjh****
KeyPairId	string	任意	バインドされたキーペアの ID。	kp-5hh431emkpuoi****
AndroidInstanceIds	array	任意	インスタンス ID のリスト。
	string	任意	インスタンス ID。	acp-25nt4kk9whhok****
AndroidInstanceName	string	任意	インスタンス名。	name
Status	string	任意	インスタンスステータス。列挙値: BACKUPING : ファイルバックアップ中。 STARTING : 起動中。 RUNNING : 利用可能。 DELETING : 削除中。 BACKUP_FAILED : ファイルバックアップ失敗。 DELETED : 削除済み。 FAILED : 作成失敗。 STOPPED : 停止済み。 RECOVERING : ファイルリカバリ中。 UNAVAILABLE : 異常。 REBOOTING : 再起動中。 RESETTING : リセット中。 STOPPING : 停止中。 RECOVER_FAILED : ファイルリカバリ失敗。 CREATING : 作成中。	RUNNING
SaleMode	string	任意	販売モード。列挙値: Instance : クラウドフォンインスタンスモード。 Node : クラウドフォンマトリックスモード。	Instance
MaxResults	integer	任意	ページングクエリにおける 1 ページあたりのエントリの最大値。有効な値: 1～100。デフォルト値: 100。	20
NextToken	string	任意	読み取りを開始する位置を示すページネーショントークン。最初から読み取りを開始するには、このパラメーターを空のままにします。	AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****
InstanceGroupIds	array	任意	インスタンスグループ ID のリスト。
	string	任意	インスタンスグループ ID。	ag-25nt4kk9whhdh****
InstanceGroupName	string	任意	インスタンスグループ名。	test
ChargeType	string	任意	課金タイプ。列挙値: PostPaid : 従量課金。 PrePaid : サブスクリプション。	PostPaid
Tag	array<object>	任意	リソースのタグ。
	object	任意	リソースのタグ。
Key	string	任意	タグキー。	key
Value	string	任意	タグ値。	value
BizRegionId	string	任意	リージョン ID。 DescribeRegions を呼び出して、クラウドフォンの購入をサポートするリージョンのリストをクエリできます。。	cn-shanghai
NodeId	string	任意	このパラメーターは一般公開されていません。。	node_id
NodeName	string	任意	このパラメーターは一般公開されていません。。	node_name
OfficeSiteIds	array	任意	クラウドフォンネットワーク ID。
	string	任意	クラウドフォンネットワーク ID。	cn-hangzhou+dir-744962****
AuthorizedUserId	string	任意	インスタンスに割り当てられたユーザー ID。China Wuying 簡便アカウント ID です。	user
QosRuleIds	array	任意	パブリックネットワークレート制限ルールグループ ID。基本共有ネットワーク内のインスタンスのレート制限ルールです。
	string	任意	パブリックネットワークレート制限ルールグループ ID。	qos-g6no280ed8byi****
AppManagePolicyId	string	任意	アプリケーション管理ポリシー ID。	amp-shigvudbyeuib****
PrivateIpAddress	string	任意	インスタンスの非公開 IP アドレス。	10.0.162.136
SortKey	string	任意
SortType	string	任意
InstanceVersion	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	F07A1DA1-E1EB-5CCA-8EED-12F85D32****
TotalCount	integer	エントリの総数。	10
NextToken	string	現在の呼び出しが読み取りした位置を示すページネーショントークン。空の値はすべてのデータが読み取り済みであることを示します。	AAAAAV3MpHK1AP0pfERHZN5pu6kmma/xxE9WtwL/ADvZ****
InstanceModel	array<object>	インスタンス情報。
	array<object>	インスタンス情報。
AndroidInstanceGroupId	string	インスタンスが属するインスタンスグループの ID。	ag-ayyhomlal7po****
AndroidInstanceGroupName	string	インスタンスグループ名。	AndroidInstanceGroupName
AndroidInstanceId	string	インスタンス ID。	acp-8at8h6ejkadjh****
AndroidInstanceName	string	インスタンス名。	name
AndroidInstanceStatus	string	インスタンスステータス。	RUNNING
NetworkInterfaceIp	string	ネットワークインターフェースの IP アドレス。	192.168.22.48
AuthorizedUserId	string	割り当てられたユーザー。	test
BindUserId	string	バインドされたユーザー。	test
PersistentAppInstanceId	string	永続会話 ID。	p-0btrd5zj8epo****
AppInstanceId	string	物理インスタンス ID。	ai-9ey6io0q58rcd****
KeyPairId	string	キーペア ID。	kp-5hh431emkpucs****
GmtCreate	string	作成時間。	2023-05-06 10:42:10
GmtModified	string	変更時間。	2023-05-06 10:42:10
AppInstanceGroupId	string	デリバリーグループ ID。	aig-i7yv6tkn7kh8dv****
RegionId	string	リージョン ID。	cn-hangzhou
Rate	integer	インスタンスデータバックアップまたはリカバリの進捗。	100
ErrorCode	string	インスタンスデータバックアップ失敗またはリカバリ失敗のエラー理由。	FilePathNotFound
RenderingType	string	レンダリングタイプ。	local
InstanceType	string	インスタンスタイプ。	acp.basic.small
ChargeType	string	インスタンスの課金タイプ。	PrePaid
GmtExpired	string	サブスクリプションインスタンスグループの有効期限時間。	2024-07-15T02:03:33Z
PolicyGroupId	string	ポリシーグループ ID。	pg-0bszojpu0seql****
OfficeSiteId	string	ネットワーク ID。コンソールでの作成時に選択したネットワーク (基本共有ネットワークまたはプレミアム共有ネットワーク) に対応します。	cn-shenzhen+dir-211620****
VSwitchId	string	VPC 内の vSwitch ID。	vsw-2zepmau2hsbhos42****
Memory	integer	メモリサイズ。	1024
Cpu	string	CPU コア数。	4
Disks	array<object>	ディスク情報。
	object	ディスク情報。
DiskType	string	ディスクのタイプ。	SYSTEM
DiskSize	integer	ディスクのサイズ (単位：GB)。	32
Tags	array<object>	タグのリスト。
	object	タグ情報。
Key	string	タグキー。	key
Value	string	タグ値。	value
ImageVersion	string	イメージバージョン。	3.5.3.867
PublicIpAddress	string	パブリック IP アドレス。	10.32.1.41
SessionStatus	string	会話の接続ステータス。列挙値: disConnect : 切断済み。 connect : 接続済み。	connect
NetworkInterfaceIpv6Address	string	説明このパラメーターは一般公開されていません。	null
PublicIpv6Address	string	説明このパラメーターは一般公開されていません。	null
ImageId	string	イメージ ID。	imgc-075cllfeuazh0****
DisplayConfig	object	ディスプレイ設定項目。
ResolutionHeight	integer	垂直解像度 (単位：ピクセル)。	1280
ResolutionWidth	integer	水平解像度 (単位：ピクセル)。	720
Dpi	integer	ドット/インチ (DPI)。	240
Fps	integer	フレームレート。	30
LockResolution	string	解像度をロックするかどうかを指定します。列挙値: off : 解像度はロックされていません。 on : 解像度はロックされています。	off
QosRuleId	string	パブリックネットワークレート制限ルール ID (プレミアム帯域幅にのみ適用)。	qos-5605u0gelk200****
AppManagePolicy	object	アプリケーション管理ポリシー情報。コンソールのアプリケーション管理ポリシーにおけるブラックリストおよびホワイトリスト管理に対応します。
AppManagePolicyId	string	アプリケーション管理ルールの ID。	amp-dgiavcvibfdds****
AppManagePolicyName	string	アプリケーション管理ルールの名前。	Application group 1
ZoneId	string	インスタンスが属するゾーンの ID。	cn-hangzhou-h
PhoneDataInfo	object	このパラメーターは一般公開されていません。。
PhoneDataId	string	独立デバイスストレージの ID。	pd-sbcudgidbhb****
PhoneDataVolume	integer	独立デバイスストレージの容量 (単位：GiB)。	20
StreamMode	integer	このパラメーターは一般公開されていません。。	1
NetworkType	string	インスタンスのネットワークタイプ。	network_pro_ecd
BandwidthPackageType	string	帯域幅タイプ。	cbwp_ecd
BandwidthPackageId	string	帯域幅パッケージ ID。	np-0q6ixs7vpxcizp***
UpBandwidthLimit	integer	アップストリーム帯域幅調整。単位: Mbit/s。	5
DownBandwidthLimit	integer	ダウンストリーム帯域幅調整。単位: Mbit/s。	30
ServerType	string	このパラメーターは一般公開されていません。。	cpm.gx7.10xlarge
BizTags	array<object>	タグ配列。
	object	タグオブジェクト。
Key	string	タグキー。	releaseFlag
Value	string	タグ値。	on
ServerStatus	string	このパラメーターは一般公開されていません。。列挙値: FAILED : 作成失敗。 RUNNING : 利用可能。 EXPIRED : 期限切れ。 DELETING : 削除中。 NODE_READY : マトリックス読み取り準備完了、インスタンス作成中。 CHANGING : マトリックスのスペック変更中。 CEASED : 支払い期限超過。 UPDATING : イメージ更新中。 CREATING : 作成中。 DATA_EXPANDING : ストレージ拡張中。	RUNNING
SystemVersion	string	Android システムバージョン。	Android 11
InternetStatus	string
BizImageType	string
Channel	string
PackageId	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "F07A1DA1-E1EB-5CCA-8EED-12F85D32****",
  "TotalCount": 10,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kmma/xxE9WtwL/ADvZ****",
  "InstanceModel": [
    {
      "AndroidInstanceGroupId": "ag-ayyhomlal7po****",
      "AndroidInstanceGroupName": "AndroidInstanceGroupName",
      "AndroidInstanceId": "acp-8at8h6ejkadjh****",
      "AndroidInstanceName": "name",
      "AndroidInstanceStatus": "RUNNING",
      "NetworkInterfaceIp": "192.168.22.48",
      "AuthorizedUserId": "test",
      "BindUserId": "test",
      "PersistentAppInstanceId": "p-0btrd5zj8epo****",
      "AppInstanceId": "ai-9ey6io0q58rcd****",
      "KeyPairId": "kp-5hh431emkpucs****",
      "GmtCreate": "2023-05-06 10:42:10",
      "GmtModified": "2023-05-06 10:42:10",
      "AppInstanceGroupId": "aig-i7yv6tkn7kh8dv****",
      "RegionId": "cn-hangzhou",
      "Rate": 100,
      "ErrorCode": "FilePathNotFound",
      "RenderingType": "local",
      "InstanceType": "acp.basic.small",
      "ChargeType": "PrePaid",
      "GmtExpired": "2024-07-15T02:03:33Z",
      "PolicyGroupId": "pg-0bszojpu0seql****",
      "OfficeSiteId": "cn-shenzhen+dir-211620****",
      "VSwitchId": "vsw-2zepmau2hsbhos42****",
      "Memory": 1024,
      "Cpu": "4",
      "Disks": [
        {
          "DiskType": "SYSTEM",
          "DiskSize": 32
        }
      ],
      "Tags": [
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "ImageVersion": "3.5.3.867",
      "PublicIpAddress": "10.32.1.41",
      "SessionStatus": "connect",
      "NetworkInterfaceIpv6Address": "null",
      "PublicIpv6Address": "null",
      "ImageId": "imgc-075cllfeuazh0****",
      "DisplayConfig": {
        "ResolutionHeight": 1280,
        "ResolutionWidth": 720,
        "Dpi": 240,
        "Fps": 30,
        "LockResolution": "off"
      },
      "QosRuleId": "qos-5605u0gelk200****",
      "AppManagePolicy": {
        "AppManagePolicyId": "amp-dgiavcvibfdds****",
        "AppManagePolicyName": "Application group 1"
      },
      "ZoneId": "cn-hangzhou-h",
      "PhoneDataInfo": {
        "PhoneDataId": "pd-sbcudgidbhb****",
        "PhoneDataVolume": 20
      },
      "StreamMode": 1,
      "NetworkType": "network_pro_ecd",
      "BandwidthPackageType": "cbwp_ecd",
      "BandwidthPackageId": "np-0q6ixs7vpxcizp***",
      "UpBandwidthLimit": 5,
      "DownBandwidthLimit": 30,
      "ServerType": "cpm.gx7.10xlarge",
      "BizTags": [
        {
          "Key": "releaseFlag",
          "Value": "on"
        }
      ],
      "ServerStatus": "RUNNING",
      "SystemVersion": "Android 11",
      "InternetStatus": "",
      "BizImageType": "",
      "Channel": "",
      "PackageId": ""
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。