Key Management Service (KMS) は、プログラムによるアクセスのための Alibaba Cloud SDK、ブラウザベースのデバッグのための OpenAPI Explorer、スクリプト作成のための Alibaba Cloud CLI、コードとしてのインフラストラクチャのための Terraform、ネイティブ HTTP 呼び出しのためのカスタム API カプセル化など、複数の連携方法をサポートしています。ほとんどのアプリケーション連携では、SDK の使用を推奨します。SDK は、リクエスト署名、リトライ、応答の解析を自動的に処理します。
連携方法
| 方法 | サポート状況 | 最適な用途 |
|---|---|---|
| Alibaba Cloud SDK | はい (推奨) | Java、Python、Go、その他の言語でのアプリケーション連携 |
| OpenAPI Explorer | はい | ブラウザでの API の探索と呼び出しのテスト |
| Alibaba Cloud CLI | はい | シェルスクリプトとアドホックな管理タスク |
| Terraform | 一部 | コードとしてのインフラストラクチャとリソースのプロビジョニング |
| カスタム API のカプセル化 | はい | リクエスト構築を完全に制御できるネイティブ HTTP 連携 |
| Resource Orchestration Service (ROS) | いいえ | — |
Alibaba Cloud SDK
SDK は推奨される連携方法です。データ署名、タイムアウト、リトライを処理し、構造化された応答オブジェクトを返します。
SDK は Java、C#、Go、Python、Node.js、TypeScript、PHP、C++ で利用できます。サポートされている言語のリスト、依存関係のインストール手順、および言語ごとのコード例については、「KMS SDK」および「Alibaba Cloud SDK」をご参照ください。
Alibaba Cloud CLI
aliyun コマンドを実行して、シェルから KMS の API オペレーションを呼び出します。詳細については、「Alibaba Cloud CLI とは」および「CLI ユーザーガイド」をご参照ください。
Terraform
Terraform は、テンプレートの解釈により、KMS リソースのプロビジョニングおよび管理を行います。サポートされているリソースと例については、「Terraform を使用した KMS リソースの管理」をご参照ください。
カスタム API のカプセル化
ネイティブ HTTP 呼び出しを行うには、リクエストを手動で作成し、V3 署名方式を使用して署名します。詳細については、「機能別操作一覧」および「リクエスト 構文および V3 署名方式」をご参照ください。
OpenAPI Explorer
OpenAPI Explorer を使用すると、ブラウザから KMS の API オペレーションの参照、ドキュメントの読み取り、ライブ呼び出しの実行、SDK サンプルコードの生成、エラーの診断、インテリジェント検索の実行、呼び出し統計の表示がすべて行えます。
API バージョン
KMS は、2016-01-20 という単一の API バージョンを使用します。これはバージョン識別子であり、日付ではありません。
| バージョン | ステータス |
|---|---|
| 2016-01-20 | 現在 (推奨) |
オンラインデバッグ
API デバッグページは https://next.api.alibabacloud.com/api/Kms/2016-01-20 です。
オペレーションを呼び出す前に、そのオペレーションのバージョン、エンドポイント、および必須パラメーターを確認してください。
エンドポイント
アクセスしたいリソースと同じリージョンのエンドポイントを選択してください。各リージョンには、パブリックエンドポイント (グローバルにアクセス可能) と Virtual Private Cloud (VPC) エンドポイント (そのリージョン内の VPC 内からのみアクセス可能) があります。
VPC エンドポイントは、パブリックエンドポイントと比較して、低レイテンシ、高スループット、パブリックインターネットへの非公開、低コストといった利点があります。
中国のリージョン
| リージョン | リージョン ID | パブリックエンドポイント | VPC エンドポイント |
|---|---|---|---|
| 中国 (杭州) | cn-hangzhou | kms.cn-hangzhou.aliyuncs.com | kms-vpc.cn-hangzhou.aliyuncs.com |
| 中国 (上海) | cn-shanghai | kms.cn-shanghai.aliyuncs.com | kms-vpc.cn-shanghai.aliyuncs.com |
| 中国 (深セン) | cn-shenzhen | kms.cn-shenzhen.aliyuncs.com | kms-vpc.cn-shenzhen.aliyuncs.com |
| 中国 (河源) | cn-heyuan | kms.cn-heyuan.aliyuncs.com | kms-vpc.cn-heyuan.aliyuncs.com |
| 中国 (広州) | cn-guangzhou | kms.cn-guangzhou.aliyuncs.com | kms-vpc.cn-guangzhou.aliyuncs.com |
| 中国 (青島) | cn-qingdao | kms.cn-qingdao.aliyuncs.com | kms-vpc.cn-qingdao.aliyuncs.com |
| 中国 (北京) | cn-beijing | kms.cn-beijing.aliyuncs.com | kms-vpc.cn-beijing.aliyuncs.com |
| 中国 (張家口) | cn-zhangjiakou | kms.cn-zhangjiakou.aliyuncs.com | kms-vpc.cn-zhangjiakou.aliyuncs.com |
| 中国 (フフホト) | cn-huhehaote | kms.cn-huhehaote.aliyuncs.com | kms-vpc.cn-huhehaote.aliyuncs.com |
| 中国 (ウランチャブ) | cn-wulanchabu | kms.cn-wulanchabu.aliyuncs.com | kms-vpc.cn-wulanchabu.aliyuncs.com |
| 中国 (成都) | cn-chengdu | kms.cn-chengdu.aliyuncs.com | kms-vpc.cn-chengdu.aliyuncs.com |
| 中国 (香港) | cn-hongkong | kms.cn-hongkong.aliyuncs.com | kms-vpc.cn-hongkong.aliyuncs.com |
中国以外のリージョン
| リージョン | リージョン ID | パブリックエンドポイント | VPC エンドポイント |
|---|---|---|---|
| シンガポール | ap-southeast-1 | kms.ap-southeast-1.aliyuncs.com | kms-vpc.ap-southeast-1.aliyuncs.com |
| マレーシア (クアラルンプール) | ap-southeast-3 | kms.ap-southeast-3.aliyuncs.com | kms-vpc.ap-southeast-3.aliyuncs.com |
| インドネシア (ジャカルタ) | ap-southeast-5 | kms.ap-southeast-5.aliyuncs.com | kms-vpc.ap-southeast-5.aliyuncs.com |
| フィリピン (マニラ) | ap-southeast-6 | kms.ap-southeast-6.aliyuncs.com | kms-vpc.ap-southeast-6.aliyuncs.com |
| タイ (バンコク) | ap-southeast-7 | kms.ap-southeast-7.aliyuncs.com | kms-vpc.ap-southeast-7.aliyuncs.com |
| 日本 (東京) | ap-northeast-1 | kms.ap-northeast-1.aliyuncs.com | kms-vpc.ap-northeast-1.aliyuncs.com |
| ドイツ (フランクフルト) | eu-central-1 | kms.eu-central-1.aliyuncs.com | kms-vpc.eu-central-1.aliyuncs.com |
| イギリス (ロンドン) | eu-west-1 | kms.eu-west-1.aliyuncs.com | kms-vpc.eu-west-1.aliyuncs.com |
| 米国 (シリコンバレー) | us-west-1 | kms.us-west-1.aliyuncs.com | kms-vpc.us-west-1.aliyuncs.com |
| 米国 (バージニア) | us-east-1 | kms.us-east-1.aliyuncs.com | kms-vpc.us-east-1.aliyuncs.com |
| UAE (ドバイ) | me-east-1 | kms.me-east-1.aliyuncs.com | kms-vpc.me-east-1.aliyuncs.com |
フィリピン (マニラ) とタイ (バンコク) はゾーンが 1 つしかないため、サービスレベルアグリーメント (SLA) は保証されません。
認証
OpenAPI Explorer にログインすると、デフォルトでは Alibaba Cloud アカウント (root ユーザー) で呼び出しが実行されます。Alibaba Cloud アカウントはすべての API オペレーションに無制限にアクセスできるため、セキュリティリスクが生じます。アプリケーションに必要な権限のみを持つ Resource Access Management (RAM) ユーザーまたは RAM ロールを使用してください。
| ID | サポート状況 |
|---|---|
| Alibaba Cloud アカウント | はい |
| RAM ユーザー (推奨) | はい |
| RAM ロール (推奨) | はい |
権限設定については、「RAM を使用したアクセス制御の実装」をご参照ください。
認証情報と権限付与の詳細については、「ID、認証情報、および権限付与」および「スロットリングとクォータ管理」をご参照ください。
注意事項
レート制限
秒間クエリ数 (QPS) の制限は、オペレーションによって異なります。各オペレーションの QPS 制限については、API リファレンスで確認してください。
同じ Alibaba Cloud アカウント配下のすべての RAM ユーザーは、そのアカウントの QPS クォータを共有します。
エラー処理
呼び出しでエラーが返された場合は、送信した入力パラメーターと値に対してエラーコードを確認してください。詳細については、「共通エラーコード」をご参照ください。
リクエスト ID または SDK エラーメッセージを使用したセルフサービス診断には、Alibaba Cloud OpenAPI 診断を使用してください。