CLI による証明書 API 呼び出しの自動化 - Certificate Management Service

このトピックでは、Certificate Management Service (Original SSL Certificate) の ListDeploymentJob API を呼び出してデプロイメントジョブのリストを取得する例を使用して、Alibaba Cloud CLI を使用して Certificate Management Service OpenAPI を呼び出す方法を示します。

基本概念

Alibaba Cloud コマンドラインインターフェイス (CLI) は、OpenAPI に基づいて構築された汎用のコマンドラインツールです。CLI は、Certificate Management Service の管理とメンテナンスの自動化に役立ちます。詳細については、「Alibaba Cloud CLI とは」をご参照ください。

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

Alibaba Cloud CLI を使用する前に、インストールする必要があります。Alibaba Cloud CLI は、Windows、Linux、macOS にインストールできます。ご利用のオペレーティングシステムに対応するインストール方法を選択してください。

Windows: 「CLI のインストール (Windows)」をご参照ください。
Linux: 「CLI のインストール (Linux)」をご参照ください。
macOS: 「CLI のインストール (macOS)」をご参照ください。

Cloud Shell には Alibaba Cloud CLI がプリインストール済みで、定期的に更新されます。 Cloud Shell を使用して Alibaba Cloud CLI コマンドをデバッグできます。詳細については、「Cloud Shell とは」をご参照ください。

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

重要

Alibaba Cloud アカウントには、すべてのプロダクトの OpenAPI オペレーションを管理およびアクセスする権限があります。これは高いセキュリティリスクを伴います。Resource Access Management (RAM) ユーザーを作成し、最小権限の原則に基づいて RAM ユーザーに権限を付与した後、RAM ユーザーを使用して OpenAPI にアクセスすることを推奨します。Certificate Management Serviceがサポートするアクセスポリシーについて詳しくは、「Certificate Management Service のシステムポリシー」をご参照ください。

CLI を使用する前に、認証情報とリージョン ID を構成する必要があります。CLI は複数の種類の認証情報をサポートしています。詳細については、「認証情報の種類」をご参照ください。この例では、RAM ユーザーの AccessKey ペアを使用して AK 認証情報を構成する方法を示します。手順は次のとおりです。

認証情報を構成するために、RAM ユーザーと AccessKey ペアを作成します。詳細については、「RAM ユーザーの作成」および「AccessKey ペアの作成」をご参照ください。
RAM ユーザーに権限を付与します。この例では、RAM ユーザーに Certificate Management Service の読み取り専用権限（AliyunYundunCertReadOnlyAccess）を付与します。詳細については、「RAM ユーザーの権限を管理する」をご参照ください。
利用可能なリージョン ID を取得して、認証情報を設定します。CLI は、指定したリージョンを使用して OpenAPI 呼び出しを行います。「Certificate Management Service」で利用可能なリージョンの詳細については、「エンドポイント」をご参照ください。

説明
CLI を使用する場合、--region オプションを使用してコマンドのリージョンを指定できます。このオプションは、デフォルトの認証情報構成および環境変数内のリージョン情報をオーバーライドします。詳細については、「コマンドラインオプション」をご参照ください。
RAM ユーザーの AccessKey ペアを使用して AK 認証情報を構成します。構成ファイルの名前を AkProfile とします。詳細については、「構成例」をご参照ください。

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

OpenAPI ポータルで、ListDeploymentJob デバッグページに移動します。
[パラメーター設定] タブで、リクエストパラメーターを入力します。[CLI 例] タブをクリックして、生成された CLI 例を表示します。
CLI の例をコピーするか、Cloud Shell で実行します：
- [実行コマンド] ボタンをクリックして、Cloud Shell を開き、コマンドをすばやくデバッグします。
- [コピー] ボタンをクリックして CLI 例をクリップボードにコピーします。その後、ローカルシェルツールに貼り付けてコマンドを実行したり、コマンドラインスクリプトを作成したりできます。
説明
- CLI 例をローカルシェルツールにコピーしてデバッグする際は、パラメーター形式に注意してください。Alibaba Cloud CLI コマンドのパラメーター形式の詳細については、「パラメーター形式」をご参照ください。
- OpenAPI ポータルで生成された例には、デフォルトで --region オプションが含まれています。コマンドをコピーしてローカルで実行する場合、CLI はデフォルトの認証情報構成および環境変数内のリージョン情報を無視し、指定されたリージョンを使用してコマンドを実行します。このオプションは必要に応じて削除または保持できます。

手順 4: Certificate Management Service OpenAPI オペレーションを呼び出す

例 1: CLI を使用して呼び出すことのできる Certificate Management Service の OpenAPI オペレーションの一覧を取得する

以下の例では、--help オプションを使用して、CLI を使用して呼び出すことができる Certificate Management Service の OpenAPI オペレーションの一覧を取得する方法を示します。詳細については、「API の概要」をご参照ください。

説明

プライベート証明書 (Certificate Management Service/2020-06-30) の OpenAPI オペレーションを呼び出すには、--force および --version オプションを使用できます。詳細については、「API 呼び出しの強制」をご参照ください。
OpenAPI ポータルがプライベート証明書 (Certificate Management Service/2020-06-30) OpenAPI オペレーションのコマンド例を生成する場合、ポータルは自動的に --force および --version オプションを追加します。手動で追加する必要はありません。
プライベート証明書 (Certificate Management Service/2020-06-30) の OpenAPI の詳細については、「API の概要」をご参照ください。

次のコマンドを実行します。
```
aliyun cas --help
```
予想される出力。

例 2: デプロイメントジョブのリストの取得

次の例では、CLI を使用して ListDeploymentJob API オペレーションを Certificate Management Service に対して呼び出し、ジョブの種類およびジョブのステータスに基づいてデプロイメントジョブのリストを取得する方法を示します。

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

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 OpenAPI オペレーションを呼び出した後にエラーが返された場合は、返されたエラーコードを使用して、リクエストパラメーターとその値が正しいかどうかを確認してください。
返された RequestID または SDK エラーメッセージを記録し、Alibaba Cloud OpenAPI 診断プラットフォームを使用してセルフサービス診断を行うことができます。