Alibaba Cloud CLIを使用してタグのAPI操作を呼び出す - Resource Management

このトピックでは、Alibaba Cloud CLIを使用してTagのAPI操作を呼び出す方法について説明します。この例では、TagのListTagResources操作を呼び出してタグを照会します。

背景情報

Alibaba Cloud CLIは、APIに基づいて開発された汎用のコマンドラインツールです。 Alibaba Cloud CLIを使用して、タグの自動管理とメンテナンスを実装できます。詳細については、「Alibaba Cloud CLI とは何か」をご参照ください。

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

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIをインストールする必要があります。 Alibaba Cloud CLIは、Windows、Linux、およびmacOSオペレーティングシステムにインストールできます。デバイスのオペレーティングシステムに基づいて、Alibaba Cloud CLIのインストールパッケージを選択します。詳細については、以下のトピックをご参照ください。

Alibaba Cloud CLIはCloud Shellにプリインストールされています。 Cloud Shellは、ID資格情報を自動的に設定します。 Cloud Shellを使用して、Alibaba Cloud CLIで実行するコマンドをデバッグできます。詳細については、「Cloud Shellとは」をご参照ください。

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

重要

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

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでID資格情報やリージョンIDなどの情報を指定する必要があります。 Alibaba Cloud CLIは、さまざまなID資格情報をサポートしています。詳細については、「資格情報の種類」をご参照ください。この例では、AccessKey資格情報が使用されます。

手順：

RAMユーザーを作成し、RAMユーザーのAccessKeyペアを作成します。詳細については、「RAM ユーザーの作成」および「AccessKeyペアの作成」をご参照ください。
RAM ユーザーに必要な権限を付与します。この例では、RAMユーザーにTagに対する読み取り専用権限を付与するには、RAMユーザーにAliyunTAGReadOnlyAccessポリシーをアタッチする必要があります。詳細については、「RAMユーザーへの権限付与」をご参照ください。
使用するリージョンのIDを取得します。 Alibaba Cloud CLIは、指定したリージョンIDを使用してAPI呼び出しを開始します。タグでサポートされているリージョンの詳細については、「エンドポイント」をご参照ください。
説明
Alibaba Cloud CLIを使用する場合、-- regionオプションを使用して、呼び出しを開始するリージョンを指定できます。このオプションを指定すると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定のリージョン情報を無視します。詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。
RAMユーザーのAccessKeyペアと取得したリージョンIDを使用して、AkProfile設定ファイルでID資格情報を設定します。詳細については、「構成例」をご参照ください。

ステップ3: CLIコマンドを生成する

OpenAPI ExplorerのListTagResourcesデバッグページに移動します。
[パラメーター] タブで、リクエストパラメーターを設定します。次に、[CLIの例] タブをクリックして、生成されたサンプルCLIコマンドを表示します。
CLIコマンドをコピーするか、Cloud ShellでCLIコマンドをデバッグします。
- アイコンをクリックしてCloud Shellを起動し、Cloud ShellでCLIコマンドをデバッグします。
- アイコンをクリックして、CLIコマンドをクリップボードにコピーします。 CLIコマンドをローカルシェルに貼り付けて、CLIコマンドを実行できます。
説明
デバッグのためにCLIコマンドをローカルシェルに貼り付けるときは、パラメーターの形式に注意してください。 Alibaba Cloud CLIで必要なパラメーター形式については、「パラメーター形式」をご参照ください。
デフォルトでは、OpenAPI Explorerは、生成されたCLIコマンドに -- regionオプションを追加します。コマンドをローカルシェルにコピーすると、Alibaba Cloud CLIはデフォルトのID資格情報設定と環境変数設定のリージョン情報を無視し、オプションで指定されたリージョンでコマンドを優先的に実行します。ビジネス要件に基づいてオプションを削除または保持できます。

ステップ4: TagのAPI操作を呼び出す

例1: Tag Alibaba Cloud CLIで呼び出すことができるAPI操作のクエリ

この例では、-- helpオプションを使用して、Alibaba Cloud CLIで呼び出すことができるTag API操作を照会します。詳細については、「関数別の操作の一覧」をご参照ください。

以下のコマンドを実行します。
```
aliyun tag --help
```
コマンド出力を表示します。

例2: タグのクエリ

この例では、Alibaba Cloud CLIでTagのListTagResources操作を呼び出して、Alibaba Cloudサービスのリソースに追加されたタグを照会します。

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

aliyun tag ListTagResources --RegionId 'cn-hangzhou'

コマンド出力を表示します。
```
{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "014738E0-3C7F-47D8-8FB9-469500C6F387",
  "TagResources": [
    {
      "ResourceARN": "arn:acs:ecs:cn-hangzhou:123456789****:instance/i-bp15hr53jws84akg****",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1",
          "Category": "Custom"
        }
      ]
    }
  ]
}
```
説明
TagのAPIを呼び出した後にエラーメッセージが返された場合は、返されたエラーコードに基づいて、リクエストパラメーターとリクエストパラメーターの値が有効かどうかを確認します。
OpenAPIの問題診断
ページで返されたリクエストIDまたはSDKエラー情報に基づいて、セルフサービス診断を実行することもできます。