Alibaba Cloud CLIを使用した証明書管理サービスのAPI操作の呼び出し - Certificate Management Service

このトピックでは、Alibaba Cloud CLIを使用してCertificate Management Service (Original SSL Certificate) のAPI操作を呼び出す方法について説明します。このトピックでは、例としてListDeploymentJob操作を使用します。 ListDeploymentJob操作を呼び出して、配置タスクのリストを取得できます。

始める前に

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

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

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

Windowsオペレーティングシステム: Windows
Linuxオペレーティングシステム: Linux
macOSオペレーティングシステム: macOS

Alibaba Cloud CLIはCloud Shellに組み込まれており、定期的にソフトウェアバージョンを更新します。 Cloud Shellを使用して、Alibaba Cloud CLIで実行するコマンドをデバッグすることもできます。詳細については、「Cloud Shellとは」をご参照ください。

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

重要

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

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでID資格情報やリージョンIDなどの情報を設定する必要があります。 Alibaba Cloud CLIは、さまざまなタイプのID資格情報をサポートしています。詳細については、「資格情報の種類」をご参照ください。 Alibaba Cloud CLIでは、RAMユーザーのAccessKeyペアを使用してID認証情報を設定できます。 RAMユーザーのAccessKeyペアを使用する場合は、次の手順を実行します。

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

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

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

手順4: Certificate Management ServiceのAPI操作の呼び出し

例1: Alibaba Cloud CLIを使用した、Certificate Management ServiceのサポートされているAPI操作の照会

この例では、-- helpオプションを使用して、Certificate Management ServiceのサポートされているAPI操作を照会する方法を示します。詳細については、「関数別の操作の一覧」をご参照ください。

説明

Alibaba Cloud CLIでは、-- forceおよび -- versionオプションを使用して、バージョン2020-06-30のプライベート認証局 (PCA) 関連のAPI操作を呼び出すことができます。詳細については、「APIの強制呼び出し」をご参照ください。
バージョン2020-06-30の証明書管理サービスAPI操作用のCLIコマンドがOpenAPI Explorerで生成されると、-- forceおよび -- versionオプションがCLIコマンドに自動的に追加されます。オプションを手動で追加する必要はありません。
バージョン2020-06-30の証明書管理サービスAPI操作の詳細については、「関数別の操作の一覧」をご参照ください。

以下のコマンドを実行します。
```
aliyun cas --help
```
期待される出力:

例2: 配置タスクのリストを取得する

この例では、Alibaba Cloud CLIを使用して証明書管理サービスのListDeploymentJob操作を呼び出す方法を示します。この操作は、展開タスクのリストを取得するために使用されます。

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

aliyun cas ListDeploymentJob --JobType user --Status pending

期待される出力:

{
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "Total": 7,
  "CurrentPage": 1,
  "ShowSize": 50,
  "Data": [
    {
      "Id": 19975,
      "GmtCreate": "1624343180000",
      "GmtModified": "1606482979000",
      "UserId": 0,
      "InstanceId": "cas-job-user-***",
      "Name": "job-test",
      "CertType": "upload",
      "ScheduleTime": "1606482979000",
      "StartTime": "1606482979000",
      "EndTime": "1606482979000",
      "Status": "scheduling",
      "Del": 1,
      "Rollback": 1,
      "JobType": "user",
      "CertDomain": "aliyundoc1.com,aliyundoc2.com,aliyundoc3.com",
      "ProductName": "NLB"
    }
  ]
}

説明

Certificate Management ServiceのAPIを呼び出した後にエラーが返された場合は、エラーコードに基づいて入力パラメーターとその値が有効かどうかを確認してください。
Alibaba Cloud OpenAPI Diagnosticsを使用し、返されたリクエストIDまたはSDKエラー情報に基づいてセルフサービス診断を実行することもできます。