リソース共有 CLI リファレンス - Resource Management - Alibaba Cloud ドキュメントセンター

このトピックでは、Resource Management の ListResourceShares 操作を使用して、現在のアカウントのリソース共有のリストを照会する例を挙げて、Alibaba Cloud CLI を使用して Resource Management の OpenAPI 操作を呼び出す方法について説明します。

背景情報

Alibaba Cloud コマンドラインインターフェイス (CLI) は、OpenAPI に基づいて構築された汎用コマンドラインツールです。Alibaba Cloud CLI を使用して、Resource Management の管理とメンテナンスを自動化できます。詳細については、「Alibaba Cloud CLI とは」をご参照ください。
バージョン 3.0.282 以降、Alibaba Cloud CLI は Resource Management の 2020-01-10 バージョンの OpenAPI を統合しています。API 呼び出しのサポートを受けるには、CLI を最新バージョンに更新することをお勧めします。

ステップ 1: Alibaba Cloud CLI のインストール

Alibaba Cloud CLI を使用する前に、インストールする必要があります。Alibaba Cloud CLI は、Windows、Linux、および macOS オペレーティングシステムにインストールできます。デバイスのオペレーティングシステムに基づいて Alibaba Cloud CLI のインストールパッケージを選択する必要があります。

Cloud Shell には Alibaba Cloud CLI がプリインストールされており、手動操作なしで認証情報が自動的に設定されます。Cloud Shell で Alibaba Cloud CLI コマンドをデバッグできます。詳細については、「Cloud Shell とは」をご参照ください。

ステップ 2: Alibaba Cloud CLI の設定

重要

Alibaba Cloud アカウントには、すべての Alibaba Cloud サービスの API を管理およびアクセスする権限があります。Alibaba Cloud アカウントを使用して API 操作を呼び出すと、セキュリティリスクが発生する可能性があります。RAM ID を作成し、最小権限の原則に基づいて権限を付与して OpenAPI 操作にアクセスすることを強くお勧めします。Resource Management でサポートされている権限ポリシーの詳細については、「Resource Management システムポリシーリファレンス」および「リソース共有の権限付与情報」をご参照ください。

Alibaba Cloud CLI を使用する前に、Alibaba Cloud CLI で認証情報やリージョン ID などの情報を設定する必要があります。Alibaba Cloud CLI は、複数のタイプの認証情報をサポートしています。詳細については、「認証情報のタイプ」をご参照ください。この例では、AccessKey 認証情報を使用します。手順:

RAM ユーザーを作成し、RAM ユーザーの AccessKey ペアを作成して認証情報を設定します。詳細については、「RAM ユーザーの作成」および「AccessKey ペアの作成」をご参照ください。
RAM ユーザーに権限を付与します。この例では、AliyunResourceSharingReadOnlyAccess ポリシーを RAM ユーザーに付与して、Resource Sharing への読み取り専用アクセスを許可します。詳細な手順については、「RAM ユーザーへの権限付与」をご参照ください。
認証情報を設定するリージョンの ID を取得します。Alibaba Cloud CLI は、指定されたリージョンを使用して OpenAPI 呼び出しを開始します。Resource Management で利用可能なリージョンの詳細については、「サービスエンドポイント」をご参照ください。
説明
Alibaba Cloud CLI を使用する場合、--region オプションを使用してコマンド呼び出しのリージョンを指定できます。このオプションを使用すると、デフォルトの認証情報設定および環境変数設定のリージョン情報は無視されます。詳細については、「コマンドラインオプション」をご参照ください。
RAM ユーザーの AccessKey とリージョン ID を使用して AccessKey 認証情報タイプを設定し、設定ファイルに AkProfile という名前を付けます。詳細については、「設定例」をご参照ください。

ステップ 3: CLI コマンドサンプルの生成

OpenAPI ポータルで、ListResourceShares デバッグページにアクセスします。
[パラメーター設定] にリクエストパラメーターを入力し、[CLI の例] タブをクリックして、生成された CLI の例を表示します。
CLI の例をコピーするか、Cloud Shell で迅速に実行します:
- [コマンドの実行] ボタンをクリックして Cloud Shell を呼び出し、コマンドのデバッグを迅速に完了します。
- [コピー] ボタンをクリックして CLI の例をクリップボードにコピーし、ローカルのシェルツールに貼り付けて実行できます。
説明
- CLI コマンドをローカルシェルに貼り付けてデバッグする場合は、パラメーターのフォーマットに注意してください。Alibaba Cloud CLI コマンドパラメーターのフォーマットの詳細については、「パラメーターのフォーマット」をご参照ください。
- OpenAPI ポータルで生成された例には、デフォルトで --region オプションが含まれます。コマンドをローカル環境にコピーすると、Alibaba Cloud CLI はデフォルトの認証情報設定と環境変数設定のリージョン情報を無視し、指定されたリージョンを使用してコマンドを呼び出すことを優先します。必要に応じて、このオプションを削除または保持できます。

ステップ 4: Resource Management OpenAPI 操作の呼び出し

Alibaba Cloud CLI がサポートする Resource Management OpenAPI 操作のリストについては、「API 概要」をご参照ください。

次の例では、Alibaba Cloud CLI を使用して Resource Management の ListResourceShares コマンドを呼び出し、現在のアカウントでアクティブなリソース共有のリストを照会する方法を示します。

次のコマンドを実行します。

aliyun resourcesharing ListResourceShares --ResourceOwner Self --ResourceShareStatus Active

コマンドの出力を表示します。

{
  "NextToken": "TGlzdFJlc291cm****",
  "RequestId": "2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA",
  "ResourceShares": [
    {
      "AllowExternalTargets": false,
      "CreateTime": "2020-12-03T02:20:31.292Z",
      "ResourceGroupId": "rg-aekz5nlvlak****",
      "ResourceShareId": "rs-PqysnzIj****",
      "ResourceShareName": "test",
      "ResourceShareOwner": "151266687691****",
      "ResourceShareStatus": "Active",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1"
        }
      ],
      "UpdateTime": "2020-12-03T08:01:43.638Z"
    }
  ]
}

説明

Resource Management OpenAPI 操作を呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて、リクエストパラメーターとその値が正しいかどうかを確認する必要があります。
呼び出しから返された RequestID または SDK のエラーメッセージを記録し、Alibaba Cloud OpenAPI 診断プラットフォームを使用して自己診断できます。