API 標準および多言語対応の SDK
本製品 (cas/2020-04-07) の 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 ペア
サブスクリプションインスタンス (V2.0)
|
API |
タイトル |
説明 |
| ListInstances | インスタンスのリストを取得します。 | インスタンスのリストを取得します。 |
| UpdateInstance | インスタンスを更新します。 | インスタンスを更新します。 |
| GetInstanceDetail | インスタンスの詳細を照会します。 | インスタンスの詳細を照会します。 |
| DeleteInstance | インスタンスを削除します。 | インスタンスを削除します。 |
| RefundInstance | インスタンスを返金します。 | 7 日以内にインスタンスを返金します。 |
| GetInstanceSummary | GetInstanceSummary | インスタンス統計情報 |
| ApplyCertificate | 証明書を申請します。 | 証明書を申請します。 |
| GetTaskAttribute | GetTaskAttribute | 送信された証明書リクエストの結果を取得します。 |
| CancelPendingCertificate | 証明書のアプリケーションを取り消します。 | 証明書のアプリケーションを取り消します。 |
| ListCertificates | 証明書の一覧を取得します。 | 証明書のリストを取得します。 |
| RevokeCertificate | 証明書を取り消します。 | 証明書を取り消します。 |
| GetCertificateDetail | 秘密鍵を除く証明書の詳細を照会します。 | 証明書の詳細を照会します。証明書の内容と秘密鍵の内容は返されません。 |
| GetUserCertificateDetail | 証明書の詳細を取得します。 | 証明書の詳細（基本情報および公開鍵/秘密鍵のコンテンツを含む）を取得します。この操作を使用して、証明書のコンテンツと秘密鍵をダウンロードできます。 |
| DeleteUserCertificate | 証明書の削除。 | 期限切れ、失効済み、またはアップロードされた証明書を削除します。 |
| UploadUserCertificate | 証明書をアップロードします。 | 標準 SM 証明書または非 SM 証明書を含む証明書をアップロードします。 |
証明書連絡先
|
API |
タイトル |
説明 |
| CreateContact | 証明書アプリケーションの連絡先を作成します。 | 証明書アプリケーションの連絡先を作成します。 |
| GetContact | 連絡先情報を取得します。 | 連絡先を取得します。 |
| ListContact | 連絡先リストの取得。 | 連絡先のリストを取得します。 |
| UpdateContact | 証明書申請の連絡先を編集します。 | 連絡先を更新します。 |
| DeleteContact | 証明書申請の連絡先を削除します。 | 連絡先を削除します。 |
企業組織
|
API |
タイトル |
説明 |
| CreateCompany | 証明書の会社組織を作成します。 | 会社を作成します。 |
| UpdateCompany | 証明書の会社組織を編集します。 | 会社情報を更新します。 |
| ListCompanies | 証明書の会社組織を取得します。 | 会社のリストを取得します。 |
| GetCompany | 証明書の会社または組織の詳細を取得します。 | 会社の詳細を取得します。 |
| DeleteCompany | 証明書の会社組織を削除します。 | 会社を削除します。 |
リソースグループ
|
API |
タイトル |
説明 |
| MoveResourceGroup | MoveResourceGroup | 証明書または証明書注文が属するリソースグループを変更します。 |
Deployment タスク
|
API |
タイトル |
説明 |
| CreateDeploymentJob | CreateDeploymentJob | 証明書デプロイメントタスクを作成します。SSL 証明書が発行された後、証明書デプロイメントタスクを作成して、証明書を Alibaba Cloud サービスにすぐにデプロイするか、特定の時点でサービスにデプロイすることができます。これにより、証明書は信頼された身分認証を実装し、サービスでホストされているウェブサイトのデータ伝送のセキュリティを確保できます。 |
| UpdateDeploymentJobStatus | UpdateDeploymentJobStatus | デプロイメントタスクのステータスを更新します。 |
| ListDeploymentJob | Deployment タスクリストの照会。 | Deployment タスクの作成後、Deployment タスクのリストを取得します。 |
| UpdateDeploymentJob | UpdateDeploymentJob | 証明書デプロイメントタスクの構成（例：証明書または対象リソース）を更新します。 |
| DescribeDeploymentJob | DescribeDeploymentJob | デプロイメントジョブの詳細を照会します。CreateDeploymentJob 操作を呼び出してデプロイメントジョブを作成し、ジョブの ID を取得できます。 |
| ListWorkerResource | ListWorkerResource | デプロイメントタスクのワーカータスクに関する詳細を照会します。Alibaba Cloud では、一度に複数の証明書をデプロイできます。そのため、1 つのデプロイメントタスクには、複数のクラウドサービスにおける複数のワーカータスクが含まれる場合があります。ワーカータスクとは、クラウドサービス内のクラウドリソースに証明書をデプロイするタスクを指します。 |
| DescribeDeploymentJobStatus | DescribeDeploymentJobStatus | デプロイメントタスク内のワーカータスクの数を照会します。 |
| ListDeploymentJobResource | ListDeploymentJobResource | 進行中のデプロイメントタスクに関連付けられているクラウドリソースのリストを取得します。空のリストは、関連付けられているリソースが無効であり、再関連付けが必要であることを示します。タスクが完了した場合、関連付けられているリソースが変更されていると、この操作は空のリストを返します。 |
| ListDeploymentJobCert | ListDeploymentJobCert | デプロイメントタスクに関連付けられた証明書（例：証明書インスタンス ID、タイプ、名前）を照会します。 |
| UpdateWorkerResourceStatus | Deployment タスク内のワーカータスクのステータスを更新します。 | Deployment タスク内のワーカータスクのステータスを更新します。 |
| DeleteWorkerResource | DeleteWorkerResource | デプロイタスクのワーカーを削除します。 |
| DeleteDeploymentJob | DeleteDeploymentJob | 証明書のデプロイメントタスクを削除します。 |
| DescribeCloudResourceStatus | DescribeCloudResourceStatus | マルチクラウドデプロイメントタスクを使用して証明書をデプロイしたサードパーティのクラウドリソースの数を照会します。 |
| ListCloudResources | ListCloudResources | クラウド サービス プロバイダー (CSP) とクラウドサービスの証明書リソースを照会します。 |
| ListCloudAccess | ListCloudAccess | マルチクラウドデプロイメント用の AccessKey ペアのリストをクエリします。 |
証明書リポジトリ
|
API |
タイトル |
説明 |
| GetCertWarehouseQuota | GetCertWarehouseQuota | 証明書リポジトリ内のデータに対する署名、署名検証、暗号化、または復号化の各 API 呼び出しでクォータが消費されます。クォータを使い切ると、それ以上の API 呼び出しはできなくなります。この操作を呼び出すことで、証明書リポジトリのクォータを照会できます。 |
| ListCertWarehouse | 証明書リポジトリリストの照会。 | 証明書リポジトリのリストを照会します。 |
| ListCert | ListCert | この API は、証明書ストア内の証明書を照会します。 |
| Sign | Sign | この操作は、証明書リポジトリの PCA 証明書を使用してデジタル署名を作成します。 |
| Verify | Verify | この API は、証明書リポジトリ内のプライベート認証局 (PCA) の証明書の署名を検証します。 |
| Encrypt | Encrypt | この操作を呼び出して、証明書リポジトリ内の証明書を暗号化できます。 |
| Decrypt | Decrypt | この API 操作は、証明書リポジトリ内の証明書を復号します。 |
| UploadPCACert | PCA 証明書を証明書リポジトリにアップロードします。 | PCA 証明書を証明書リポジトリにアップロードします。 |
| DeletePCACert | DeletePCACert | 証明書アプリケーションリポジトリからプライベート証明書を削除します。 |
| CreateWHClientCertificate | CreateWHClientCertificate | 一般ユーザー証明書リポジトリから単一のクライアント証明書を発行します。 |
| RevokeWHClientCertificate | RevokeWHClientCertificate | クライアント証明書を証明書リポジトリから取り消します。 |
CSR 管理
|
API |
タイトル |
説明 |
| ListCsr | ListCsr | CSR の詳細を照会します。 |
| CreateCsr | CreateCsr | 証明書署名要求 (CSR) を作成します。CSR ファイルには、申請する SSL 証明書に関する情報が含まれます。この情報には、証明書にバインドするドメイン名、証明書の所有者の名前、および地理的な場所が含まれます。認証局 (CA) に証明書申請を提出する際、CSR を提供する必要があります。CA が証明書申請を承認すると、CA はルート CA の秘密鍵を使用して CSR に署名し、公開鍵ファイルを生成します。この公開鍵ファイルが、CA から発行される SSL 証明書です。SSL 証明書の秘密鍵は、CSR の作成時に生成されます。 |
| UploadCsr | UploadCsr | Alibaba Cloud Digital Certificate Management Service では、既存の証明書署名リクエスト (CSR) をアップロードできます。アップロードした CSR を使用して証明書をリクエストし、アップロードしたすべての CSR を一元管理できます。 |
| GetCsrDetail | GetCsrDetail | 証明書署名要求 (CSR) ファイルの内容を取得します。 |
| UpdateCsr | CSR の秘密鍵のアップロードまたは更新。 | ローカル CSR のアップロード時に秘密鍵を指定しなかった場合に、CSR に対応する秘密鍵をアップロードします。 |
| DeleteCsr | DeleteCsr | 不要になった証明書署名要求 (CSR) を削除します。 |
注文 (V1.0)
|
API |
タイトル |
説明 |
| DescribePackageState | DescribePackageState | 購入したドメイン検証 (DV) 証明書のクォータとクォータ使用量を照会します。 |
| ListUserCertificateOrder | ユーザーの証明書または注文を照会します。 | ユーザーの証明書または注文のリストを照会します。 |
| CreateCertificateForPackageRequest | CreateCertificateForPackageRequest | 証明書申請を送信します。 |
| CancelCertificateForPackageRequest | CancelCertificateForPackageRequest | 注文が発行済みの場合、この操作は証明書を取り消します。注文が保留中の場合、この操作は注文をキャンセルし、クォータを復元します。 |
| CancelOrderRequest | CancelOrderRequest | 検証待ちまたは審査中の証明書申請注文をキャンセルします。 |
| RenewCertificateOrderForPackageRequest | RenewCertificateOrderForPackageRequest | 発行済みの証明書の更新申請を提出します。 |
証明書リクエスト (V1.0)
|
API |
タイトル |
説明 |
| DescribeCertificateState | DescribeCertificateState | 証明書アプリケーション注文のステータス（ドメイン検証の進捗状況など）を照会します。 |
| CreateCertificateWithCsrRequest | CreateCertificateWithCsrRequest | カスタムの証明書署名要求 (CSR) ファイルを使用して、ドメイン検証 (DV) 証明書を購入、申請、発行します。証明書サービスの拡張機能を利用することで、数回のクリック操作で DV 証明書を購入・申請できます。 |
| CreateCertificateRequest | CreateCertificateRequest | 拡張証明書サービスを利用して、ドメイン検証 (DV) 証明書の購入、申請、発行を行います。 |
| DeleteCertificateRequest | DeleteCertificateRequest | ドメイン検証 (DV) 証明書の申請に失敗した注文を削除します。 |
その他
|
API |
タイトル |
説明 |
| AddCloudAccess | AddCloudAccess | 権限付与のための AccessKey を追加します。 |
| CreateWarehouse | 証明書アプリケーションリポジトリを作成します。 | 証明書リポジトリを作成します。 |
| DeleteCloudAccess | DeleteCloudAccess | アクセスキーを削除します。 |
| DeleteWarehouse | DeleteWarehouse | 証明書ウォレハウスを削除します。 |
| DescribeWarehouseCert | DescribeWarehouseCert | 証明書ウェアハウスに保存されている証明書の詳細を取得します。 |
| GetAssetCount | アセット数の照会。 | アセットの数を照会します。 |
| GetRiskCount | GetRiskCount | リスクのある資産の数をカウントします。 |
| ListAssetCount | クラウドサービスのリソース統計を照会します。 | クラウドサービスのリソース統計リストを照会します。 |
| ListWarehouse | ListWarehouse | ウェアハウスの一覧を取得します。 |
| BatchUpdateNoticeStatus | BatchUpdateNoticeStatus | 通知ステータスを一括で更新します。 |
| GetMatchedResources | GetMatchedResources | 証明書に一致するリソースを取得します。 |
| CreateRollbackTask | Deployment をロールバックします。 | Deployment をロールバックします。 |
| GetCertificatePackageCount | 証明書リソースプランの数量を取得します。 | 証明書リソースプランの数量を取得します。 |
| ListTagKeys | タグキーの照会。 | タグキーと値のリストを取得します。 |
| ListTagResources | リソースのタグリストを取得します。 | リソースに関連付けられたタグを取得します。 |
| ListTrusteeOrder | 管理対象注文リストの取得。 | 管理対象注文のリストを取得します。 |
| ShareCertificate | 証明書を共有します。 | 証明書を共有します。 |
| TagResources | 指定されたリソース (SSL 証明書インスタンス) にタグをアタッチします。 | リソースタグを追加します。 |
| UntagResources | 指定されたリソース (SSL 証明書インスタンス) からタグを削除します。 | タグを削除します。 |