API 標準および多言語対応の SDK
本製品 (eds-aic/2023-09-30) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
JVS モバイル
|
API |
タイトル |
説明 |
| CreateCreditPackage | CreateCreditPackage | クレジットパッケージの注文を作成します。 |
| DescribeCreditPackage | DescribeCreditPackage | 1 つ以上のクレジットパッケージの詳細を取得します。 |
| CreateMobileAgentPackage | CreateMobileAgentPackage | パッケージの注文を作成します。 |
| DeleteMobileAgentPackage | パッケージを削除します | ノードパッケージを削除します。 |
| DescribeMobileAgentPackage | DescribeMobileAgentPackage | 1 つ以上のノードパッケージの詳細を取得します。 |
| RenewMobileAgentPackage | RenewMobileAgentPackage | モバイルエージェントパッケージを更新します。 |
| ModifyJVSInstance | ModifyJVSInstance | JVS インスタンスの構成を変更します。 |
| DescribeJVSInstance | DescribeJVSInstance | JVS インスタンスの詳細を取得します。 |
| RunAgentTask | エージェントタスクを実行します。 | エージェントをトリガーして、モバイルノードで AI 自動化タスクを実行します。 |
| DescribeAgentTask | エージェントタスクの詳細を照会します。 | エージェントタスクの情報を照会します。 |
| CancelAgentTask | CancelAgentTask | モバイルノードで実行中のエージェントタスクをキャンセルします。 |
| PauseAgentTask | PauseAgentTask | モバイルノードで実行中のエージェントタスクを一時停止します。 |
| ResumeAgentTask | ResumeAgentTask | モバイルインスタンス上で一時停止されたエージェント自動化タスクを再開します。 |
クラウドフォンマトリックス
|
API |
タイトル |
説明 |
| CreateCloudPhoneNode | CreateCloudPhoneNode | Cloud Phone では、マトリックスは物理サーバーインスタンスを表す論理的なリソース管理ユニットです。マトリックスを作成すると物理サーバーがプロビジョニングされ、それを複数の独立した Cloud Phone インスタンスにパーティション分割できます。これらのインスタンスは、マトリックスのコンピューティング、ストレージ、およびネットワークリソースを共有します。マトリックスの構成によって、作成できるインスタンスの数が決まります。 |
| DescribeCloudPhoneNodes | DescribeCloudPhoneNodes | Cloud Phone マトリックスの詳細情報を照会します。Cloud Phone では、マトリックス（Cloud Phone Server）は、物理サーバを表す論理的なリソース管理単位です。このサーバは、マトリックスの基盤となるコンピューティング、ストレージ、ネットワークリソースを共有する複数の独立した Cloud Phone インスタンスに分割できます。マトリックスを作成することは、Cloud Phone インスタンスを作成可能な物理サーバを取得することと同等です。作成可能なインスタンス数は、構成によって異なります。 |
| ModifyCloudPhoneNode | ModifyCloudPhoneNode | Cloud Phone マトリックスの情報を変更します。Cloud Phone システムでは、マトリックス (Cloud Phone サーバー) は、物理サーバーインスタンスを表す論理リソース管理ユニットです。この物理サーバーは、独立して実行される複数の Cloud Phone インスタンスにパーティション分割できます。これらのインスタンスは、マトリックスの基盤となるコンピューティング、ストレージ、およびネットワークリソースを共有します。マトリックスを作成することは、Cloud Phone インスタンスをホストできる物理サーバーを取得することと同じです。ホストできるインスタンスの数は、サーバーの構成によって異なります。 |
| RenewCloudPhoneNodes | RenewCloudPhoneNodes | 指定されたクラウドフォンマトリックスを更新します。 |
| ChangeCloudPhoneNode | ChangeCloudPhoneNode | クラウドフォンマトリックスの構成を、インスタンスタイプとクラウドフォンインスタンスの数を含めて変更します。 |
| ExpandDataVolume | ExpandDataVolume | クラウドフォンマトリックスのストレージを拡張します。イメージなどのマトリックスレベルのファイル用の共有ストレージとインスタンスストレージを拡張できます。ストレージの拡張には新しい料金が発生し、API の応答で注文 ID が返されます。 |
| DeleteCloudPhoneNodes | DeleteCloudPhoneNodes | クラウドフォンマトリックスを削除します。 |
インスタンスグループ
|
API |
タイトル |
説明 |
| DescribeSpec | DescribeSpec | クラウドフォンの利用可能な仕様をクエリします。この情報はインスタンスを作成する際に必要です。クラウドフォンマトリックスモードの場合、この操作ではマトリックスあたりに許可されるインスタンス数の最小値と最大値も返されます。 |
| CheckResourceStock | Check Resource Stock Status | クラウドフォンリソースの在庫を確認します。インスタンスを作成する前に、この操作を呼び出して、ターゲットリージョンでリソースが利用可能かどうかを確認します。リソースが利用可能であることを確認した後にのみ、インスタンスを作成してください。 |
| CreateAndroidInstanceGroup | CreateAndroidInstanceGroup | 従量課金またはサブスクリプションのクラウドフォンインスタンスグループを作成します。インスタンスグループは複数のインスタンスを管理できます。同様の機能を持つインスタンスをインスタンスグループにまとめることで、単一のユニットとして管理できます。 |
| DescribeAndroidInstanceGroups | インスタンスグループの詳細を照会します | クラウドフォンインスタンスグループの詳細を照会します。 |
| ModifyAndroidInstanceGroup | ModifyAndroidInstanceGroup | クラウドフォンインスタンスグループの属性を変更します。 |
| UpgradeAndroidInstanceGroup | UpgradeAndroidInstanceGroup | インスタンスグループをアップグレードします。この操作はインスタンスグループのスケールアウト (インスタンス数の増加) のみをサポートします。 |
| DowngradeAndroidInstanceGroup | DowngradeAndroidInstanceGroup | インスタンスグループをダウングレードします。現在、この操作では、インスタンスグループから特定のクラウドフォンインスタンスを削除することのみが可能です。 |
| RenewAndroidInstanceGroups | RenewAndroidInstanceGroups | サブスクリプション方式の Cloud Phone インスタンスグループを更新します。サブスクリプション方式のインスタンスグループの有効期限が切れると、システムは 15 日後にそのインスタンスグループとインスタンスを自動的に削除します。削除されたリソースは復元できません。リソースの損失を防ぐため、インスタンスグループを速やかに更新してください。 |
| UpdateInstanceGroupImage | UpdateInstanceGroupImage | インスタンスグループのイメージを更新します。この更新は、グループ内のすべてのインスタンスに影響します。 |
| DeleteAndroidInstanceGroup | DeleteAndroidInstanceGroup | Android インスタンスグループを削除します。グループ内のすべてのインスタンスも削除されます。この操作は元に戻すことができません。慎重に行ってください。 |
インスタンス
|
API |
タイトル |
説明 |
| DescribeAndroidInstances | インスタンスの詳細を照会します | クラウドフォンインスタンスの詳細を照会します。 |
| ModifyAndroidInstance | ModifyAndroidInstance | Android インスタンスの情報を変更します。現在、この操作はインスタンス名とアップストリームおよびダウンストリームの帯域幅制限の変更にのみ使用できます。 |
| AuthorizeAndroidInstance | Assign Users to Instances & Unassign | ユーザーに対して Android インスタンスの割り当て、または割り当て解除を行います。 |
| StartAndroidInstance | Start Instance | クラウドフォンインスタンスを起動します。 |
| StopAndroidInstance | StopAndroidInstance | Android インスタンスを停止 (シャットダウン) します。 |
| RebootAndroidInstancesInGroup | RebootAndroidInstancesInGroup | 指定されたクラウドフォンインスタンスを再起動します。 |
| ResetAndroidInstancesInGroup | ResetAndroidInstancesInGroup | 元のイメージからオペレーティングシステムを再インストールすることで、1 つ以上の Cloud Phone インスタンスをリセットします。インスタンスの作成に使用したイメージが削除されている場合、この操作は失敗します。 |
| UpdateInstanceImage | UpdateInstanceImage | クラウドフォンマトリックスインスタンスのイメージを変更します。インスタンスのイメージは、インスタンスが `実行中`、`停止済み`、またはイメージ更新失敗状態の場合にのみ変更できます。ターゲットイメージの GPU ベンダーは、インスタンスが実行されているサーバーの GPU ベンダーと一致している必要があります。例えば、Android 10 から Android 12 のように、メジャーバージョンをまたいでイメージを変更する場合、システムはインスタンス上のすべてのユーザーデータを自動的にクリアします。この場合、この操作は、イメージの変更後にインスタンスをリセットする操作と同等です。 |
| ExpandPhoneDataVolume | ExpandPhoneDataVolume | 1 つ以上のマトリックスインスタンスのフォンストレージを拡張します。 |
| InstanceHealer | InstanceHealer | クラウドフォンマトリックスインスタンスを診断し、回復します。この操作は、インスタンスのシステムログファイルをクリアして、ディスクがいっぱいになることによるインスタンスの回復不能を防ぎます。 |
| StartInstanceAdb | StartInstanceAdb | この操作は、インスタンスの Android Debug Bridge (ADB) 接続を有効にし、その ADB ポートのインターネットマッピングルールを作成します。この機能は、標準ネットワークでのみ利用可能です。 |
| StopInstanceAdb | StopInstanceAdb | Android インスタンスの ADB 接続を無効にし、その ADB ポートフォワーディングルールを削除します。この操作は、標準ネットワークにのみ適用されます。 |
| ListInstanceAdbAttributes | ListInstanceAdbAttributes | インスタンスの Android Debug Bridge (ADB) 接続情報をクエリします。この操作は、標準ネットワークでのみ利用可能です。 |
| 接続と切断 | 接続と切断 | |
| BatchGetAcpConnectionTicket | BatchGetAcpConnectionTicket | 接続チケットをバッチで取得します。この操作はチケットを非同期で生成します。ほとんどの場合、チケットは最初の応答で直接返されます。場合によっては、最初の応答に TaskId が含まれています。チケットが生成されるまで、その TaskId を使用してこの操作をポーリングします。 |
| DisconnectAndroidInstance | DisconnectAndroidInstance | 接続中のインスタンスを切断するか、別のユーザーにアタッチされているインスタンスをデタッチします。 |
| リモートコマンド | リモートコマンド | |
| RunCommand | RunCommand | 1 つ以上のクラウドフォンインスタンスでコマンドを実行します。 |
| DescribeInvocations | DescribeInvocations | RunCommand 操作を呼び出すことによって実行されたコマンドの実行結果をクエリします。 |
| RunSyncCommand | RunSyncCommand | 1 台以上の Cloud Phone インスタンスで同期コマンドを実行し、実行結果を返します。 |
| ファイルのアップロードとダウンロード | ファイルのアップロードとダウンロード | |
| SendFile | SendFile | Object Storage Service (OSS) またはパブリックダウンロードリンクからクラウドフォンにファイルを送信します。 |
| FetchFile | FetchFile | クラウドフォンから Object Storage Service (OSS) にファイルをフェッチします。 |
| スクリーンショット | スクリーンショット | |
| CreateScreenshot | CreateScreenshot | クラウドフォンのスクリーンショットを生成します。これは非同期 API です。 |
| ストリームコラボレーション | ストリームコラボレーション | |
| GenerateCoordinationCode | GenerateCoordinationCode | デフォルトでは、クラウドフォンは 1 つのユーザー接続のみをサポートします。接続チケットは、BatchGetAcpConnectionTicket API を呼び出すことによってのみ取得できます。複数のユーザーが同じクラウドフォンに接続できるようにするには、現在の無影簡便アカウントによって接続されているクラウドフォンに対して調整コードを生成できます。その後、コードを他の簡便アカウントと共有して、クラウドフォンへの接続を許可できます。 |
| EndCoordination | EndCoordination | クラウドフォン インスタンスのすべての連携タスクを終了し、連携コードを無効にします。 |
イメージ
|
API |
タイトル |
説明 |
| ImportImage | ImportImage | カスタムイメージをインポートします。 |
| DescribeImageList | DescribeImageList | 利用可能なイメージのリストを照会します。 |
| CreateCustomImage | CreateCustomImage | クラウドフォンインスタンスからカスタムイメージを作成します。このカスタムイメージを使用して、同じ構成の追加のクラウドフォンインスタンスを作成できます。 |
| UpdateCustomImageName | UpdateCustomImageName | カスタムイメージの名前を更新します。 |
| DistributeImage | DistributeImage | 1 つ以上のリージョンにイメージを配布します。 これにより、ソースリージョン以外のリージョンでイメージを使用してクラウドフォンを作成できます。 |
| DeleteImages | DeleteImages | カスタムイメージを削除します。 |
アプリケーション
|
API |
タイトル |
説明 |
| CreateApp | CreateApp | Android アプリケーションを作成します。アプリケーションをインストールする前に、この API 操作を使用してアプリケーションを作成する必要があります。アプリケーションは作成時にはダウンロードされません。インストール中にのみダウンロードされます。クラウドフォンがダウンロード URL にアクセスできることを確認してください。 |
| DescribeApps | DescribeApps | 作成されたアプリケーションの情報を照会します。 |
| ModifyApp | ModifyApp | アプリケーションの属性を変更します。 |
| DeleteApps | DeleteApps | アプリケーションを削除します。アプリケーションを削除する前に、そのアプリケーションがどのインスタンスにもインストールされていないことを確認してください。 |
| InstallApp | InstallApp | Cloud Phone インスタンスにアプリケーションを一括でインストールします。 |
| UninstallApp | UninstallApp | 1 つ以上の Cloud Phone インスタンスからアプリケーションをアンインストールします。 |
| OperateApp | OperateApp | クラウドフォン内のアプリを操作します。たとえば、アプリの起動、終了、再起動などが可能です。 |
キーペア
|
API |
タイトル |
説明 |
| CreateKeyPair | CreateKeyPair | Android Debug Bridge（ADB）を使用してクラウドフォンに接続できます。 ADB を使用すると、デバイスとアプリケーションを管理し、ファイルを転送できます。 これらの操作には高い権限が必要です。 クラウドフォンには物理インターフェイスがないため、USB 接続を使用してデバイスで承認ダイアログボックスをトリガーすることはできません。 したがって、ネットワーク経由で ADB を使用してクラウドフォンに接続する前に、キーペアを設定する必要があります。 このキーペアにより、デバイスがクライアントを信頼し、すべての操作が安全であることが保証されます。 CreateKeyPair 操作を呼び出して、ADB キーペアを作成できます。 システムは公開鍵を保存し、秘密鍵を返します。 秘密鍵は PEM エンコードされた PKCS#8 形式であり、ADB 接続標準に準拠しています。 秘密鍵は安全に保管する必要があります。 |
| DescribeKeyPairs | DescribeKeyPairs | 1 つ以上のキーペアを照会します。 |
| ImportKeyPair | ImportKeyPair | ADB ツールによって生成されたキーペアの公開鍵をインポートします。 |
| ModifyKeyPairName | ModifyKeyPairName | Android Debug Bridge (ADB) キーペアを変更します。 |
| DeleteKeyPairs | DeleteKeyPairs | Android Debug Bridge (ADB) キーペアを削除します。 |
| AttachKeyPair | AttachKeyPair | AttachKeyPair を呼び出して、1 つ以上のクラウド携帯電話インスタンスに Android Debug Bridge (ADB) キーペアをアタッチします。 |
| DetachKeyPair | DetachKeyPair | 1 つ以上のクラウドフォンインスタンスから Android Debug Bridge (ADB) キーペアをデタッチします。 |
| SetAdbSecure | SetAdbSecure | インスタンスの Android Debug Bridge (ADB) 認証ステータスを設定します。 ADB 認証を有効にすると、接続時にインスタンスが ADB キーペアを検証します。ADB を使用してインスタンスに接続する前に、ADB キーペアをアタッチする必要があります。 ADB 認証を無効にすると、インスタンスは ADB キーペアを検証しません。ネットワーク接続が利用可能であれば、ADB を使用してインスタンスに接続できます。 |
バックアップ
|
API |
タイトル |
説明 |
| DescribeBackupFiles | バックアップファイルを照会します | バックアップファイルのリストを照会します。 |
| DescribeBuckets | DescribeBuckets | バケットに関する情報を照会します。この操作は、名前が `cloudphone-saved-bucket-` で始まるバケットのみを返します。 |
| BackupAndroidInstance | BackupAndroidInstance | Elastic Cloud Phone (ECP) インスタンスの完全バックアップを作成します。バックアップには、インストール済みのアプリケーションとプロパティが含まれます。 |
| BackupApp | BackupApp | クラウドフォンインスタンス上の指定されたアプリケーションをバックアップします。バックアップには、アプリケーションとそのキャッシュが含まれます。 |
| RecoverAndroidInstance | RecoverAndroidInstance | インスタンス全体のバックアップファイルを別の Android インスタンスに復元します。 |
| RecoverApp | RecoverApp | バックアップファイルから別のクラウドフォンインスタンスにアプリケーションを回復します。 |
| BackupFile | BackupFile | バックアップファイルを生成し、リモートストレージにアップロードします。この操作は、定期的なデータバックアップにご利用いただけます。また、1 つのインスタンスからファイルをバックアップし、複数のインスタンスに復元することも可能です。これは、データレプリケーションまたは移行と類似したプロセスです。 |
| RecoveryFile | RecoveryFile | バックアップファイルを回復します。 |
| DeleteBackupFile | DeleteBackupFile | バックアップファイルを一括で削除します。 |
ポリシー
|
API |
タイトル |
説明 |
| CreatePolicyGroup | CreatePolicyGroup | クラウドフォンに統一された設定を適用するポリシーを作成します。これらの設定には、ネットワークリダイレクト、ウォーターマーク、解像度、クリップボードなどの機能が含まれます。 |
| ListPolicyGroups | ポリシーの詳細を照会します。 | ポリシーの詳細を照会します。 |
| ModifyPolicyGroup | ModifyPolicyGroup | ポリシーグループの情報を変更します。 |
| DeletePolicyGroup | DeletePolicyGroup | 1 つ以上のポリシーグループを削除します。 |
システムプロパティテンプレート
|
API |
タイトル |
説明 |
| CreateSystemPropertyTemplate | CreateSystemPropertyTemplate | システムプロパティテンプレートを作成します。テンプレートで定義されたキーと値のペアはクラウドフォンに送信され、setprop コマンドを使用して Android システムのプロパティとして設定されます。その後、APK または関連プログラムはこれらのプロパティ値を読み取ることができます。 |
| SendSystemPropertyTemplate | SendSystemPropertyTemplate | プロパティテンプレートをクラウドフォンに送信します。プロパティは、setprop コマンドを使用して Android システムに設定されます。APK または関連プログラムは、これらのプロパティ値を読み取ることができます。複数のテンプレート ID を指定した場合、プロパティテンプレートとクラウドフォンインスタンスはランダムに照合されます。 |
| DescribeSystemPropertyTemplates | DescribeSystemPropertyTemplates | システムプロパティテンプレートを記述します。 |
| GetInstanceProperties | GetInstanceProperties | インスタンスのプロパティを取得します。この操作は、android getprop コマンドを実行して、クラウドフォンのすべてのプロパティを取得します。 |
| ModifySystemPropertyTemplate | ModifySystemPropertyTemplate | プロパティテンプレートを変更します。 |
| DeleteSystemPropertyTemplates | DeleteSystemPropertyTemplates | システムプロパティテンプレートを削除します。 |
モニタリング
|
API |
タイトル |
説明 |
| InstallMonitorAgent | InstallMonitorAgent | ワンステップでモニタリングプラグインをインストールします。プラグインをインストールした後にのみ、インスタンスはモニタリングデータを生成できます。 |
| UninstallMonitorAgent | UninstallMonitorAgent | モニタリングプラグインをアンインストールします。 |
| DescribeMetricLast | DescribeMetricLast | インスタンスまたはマトリックスの最新のモニタリングデータをクエリします。CPU、メモリ、ディスク、ネットワークなどのメトリックをクエリできます。 |
| DescribeMetricList | DescribeMetricList | ネットワーク帯域幅など、指定されたメトリックのモニタリングデータを照会します。 |
| DescribeMetricTop | DescribeMetricTop | インスタンスのネットワーク帯域幅などのメトリックの最新のモニタリングデータをクエリし、ソートされたリストで結果を返します。 |
その他
|
API |
タイトル |
説明 |
| ModifyDisplayConfig | ModifyDisplayConfig | 表示設定を変更します。 |
| DescribeDisplayConfig | DescribeDisplayConfig | 表示設定をクエリします。 |
| GetNetworkBlacklist | GetNetworkBlacklist | IP アドレスとドメイン名のネットワークアクセスブラックリストをクエリします。 |
| SetNetworkBlacklist | SetNetworkBlacklist | ネットワークアクセスブラックリストに IP アドレスとドメイン名を追加または消去します。 |
| DescribeRegions | Query Available Regions | 利用可能なリージョンを照会します。 |
| DescribeTasks | DescribeTasks | Elastic Cloud Phone（ECP）インスタンスのタスクリストをクエリします。ECP インスタンスに対する作成、起動、シャットダウンなどの多くの操作は非同期です。システムは各操作に対してタスク ID を生成します。タスク ID を使用して、操作の進捗状況と結果をクエリできます。また、この API 操作を呼び出して、すべてのタスクとその実行ステータスのリストをクエリすることもできます。 |
| ListTagResources | ListTagResources | クラウドフォン (CP) インスタンスにアタッチされているタグをクエリします。 |
| ModifyInstanceChargeType | ModifyInstanceChargeType | 課金方法を変更します。現在、この操作では課金方法を従量課金からサブスクリプションにのみ変更できます。 |
| TagResources | TagResources | 1 つ以上のクラウドフォンにタグを追加します。 |
| UntagResources | UntagResources | クラウドフォンからタグを削除します。タグが削除された後、どのクラウドフォンにもアタッチされなくなった場合、そのタグは自動的に削除されます。 |
Others
|
API |
タイトル |
説明 |
| ActivateEdgeMobileAgent | エッジエージェントデバイスを有効化します。 | エッジエージェントデバイスを有効化します。 |
| CreateEdgeMobileAgentPackage | エッジエージェントパッケージの購入。 | エッジスマートゲートウェイエージェントパッケージを購入する注文を作成します。 |
| DescribeCreditDetail | クレジットの詳細を照会します。 | クレジットのすべての変更レコードを照会します。 |
| DescribeEdgeMobileAgentPackages | エッジエージェントパッケージの詳細を照会します。 | エッジエージェントパッケージの詳細を照会します。 |
| RefreshAuthTokens | モデル認証トークンをリフレッシュします。 | モデル認証トークンをリフレッシュします。 |