Key Management Service (KMS) は、視覚的な操作のためのコンソールと、OpenAPI Explorer、Alibaba Cloud SDK、TerraformなどのAPI操作を呼び出すための複数のメソッドを提供します。 OpenAPI Explorerは、API操作のオンラインデバッグをサポートします。
OpenAPI Explorerの概要
Alibaba Cloudは、開発者がさまざまなAlibaba CloudサービスのAPI操作を迅速かつ効率的に理解して使用するためのOpenAPI Explorerを提供しています。 OpenAPI Explorerは、インテリジェント検索、ドキュメント、オンラインデバッグ、SDK取得、CodeSample、コールエラー診断、コール統計のAPI操作の機能を統合しています。 OpenAPI Explorerでは、Alibaba CloudサービスのAPI操作を呼び出し、APIのリクエストとレスポンスを表示できます。 さらに、OpenAPI Explorerは、対応するSDKサンプルコードを自動的に生成し、Alibaba Cloudサービスの使用を容易にします。 詳細については、「APIとは何ですか?」をご参照ください。
バージョンの説明
OpenAPI Explorerは、バージョン2016-01-20のAPIのオンラインデバッグをサポートします。 2016-01-20は、日付ではなくAPIバージョン番号です。 ユーザーには、APIに関する最新の公開情報が提供されます。 2016-01-20はKMS APIの最新バージョンです。 APIのバージョンを表示する方法の詳細については、「APIバージョン」をご参照ください。
バージョン | 説明 |
推奨 |
オンラインデバッグ
KMSは、OpenAPI ExplorerでのAPIデバッグなどの機能を提供します。 API操作を呼び出す前に、KMSが提供するバージョン、エンドポイント、およびパラメーターの情報に注意してください。
APIデバッグページのURLは https://next.api.alibabacloud.com/api/Kms/2016-01-20です。
.
エンドポイント
レイテンシを減らすために、アクセスするリソースが存在するリージョンに基づいてエンドポイントを選択することを推奨します。 たとえば、KMSが中国 (杭州) リージョンにある場合、パブリックエンドポイントはkms.cn-hangzhou.aliyuncs.comで、仮想プライベートクラウド (VPC) エンドポイントはkms-vpc.cn-hangzhou.aliyuncs.comです。
パブリックエンドポイントはグローバルにアクセスできます。
VPCエンドポイントには、特定のAlibaba CloudリージョンのVPC内からのみアクセスできます。 VPCエンドポイントには次の利点があります。
より高いセキュリティ: VPCエンドポイントはVPC内からのみアクセスできます。 これにより、より高いセキュリティとプライバシーが提供されます。
高速応答: 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
フィリピン (マニラ)
重要このリージョンでは、1つのゾーンのみが存在し、サービスレベル契約 (SLA) は保証されていません。
ap-southeast-6
kms.ap-southeast-6.aliyuncs.com
kms-vpc.ap-southeast-6.aliyuncs.com
タイ (バンコク)
重要このリージョンでは、1つのゾーンのみが存在し、SLAは保証されません。
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
ID
Alibaba Cloudアカウントを使用してOpenAPI Explorerにログインすると、OpenAPI ExplorerはAlibaba Cloudアカウントを使用して、デフォルトでオンラインでAPI操作をデバッグします。 Alibaba Cloudアカウントには、すべてのAPI操作に対する権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) ユーザーとしてAPI操作を呼び出すか、ルーチンのO&Mを実行することを強くお勧めします。 RAMユーザーを使用してAPI操作を呼び出す前に、ビジネス要件に基づいて必要な権限をRAMユーザーに付与します。 詳細については、「Use RAM to implement access control」をご参照ください。
ID | 対応 |
対象 | |
RAMユーザー (推奨) | 対象 |
RAMロール (推奨) | 対象 |
関連ドキュメント
統合方法
SDKはアプリケーションと簡単に統合でき、幅広い操作をカバーできます。 SDKを使用してAPI操作を呼び出すことを推奨します。
統合方法 | 対応 |
対象 | |
対象 | |
非対象 | |
部分的に | |
対象 |
Alibaba Cloud SDK
Alibaba Cloudは、Java、C# 、Go、Python、Node.js、TypeScript、PHP、C ++ などの複数のプログラミング言語でSDKを提供しています。 SDKをアプリケーションと統合して、API操作を直接呼び出すことができます。 SDKは、データ署名ロジック、タイムアウトメカニズム、再試行メカニズムなど、さまざまな情報をカプセル化します。 SDKは、開発を容易にするために仕様に基づいて構造化応答オブジェクトを返します。 詳細は、「Alibaba Cloud SDK」をご参照ください。
KMS SDKを使用してAPI操作を呼び出すことができます。 KMS SDKでサポートされているプログラミング言語と関連する依存関係のインストール方法の詳細については、
「KMS SDK」をご参照ください。
Alibaba Cloud CLI
aliyunコマンドを実行して、Alibaba Cloudサービスと対話し、クラウドサービスリソースを管理できます。 詳細については、「Alibaba Cloud CLIとは」をご参照ください。Alibaba Cloud CLIを使用して、KMSのAPI操作を呼び出すことができます。 詳細については、「Alibaba Cloud CLIのユーザーガイド」をご参照ください。
ROS
Resource Orchestration Service (ROS) は、クラウドコンピューティングリソースの管理を簡素化できるAlibaba Cloudサービスです。 Elastic Compute Service (ECS) やApsaraDB RDSインスタンスなど、必要なクラウドコンピューティングリソース、およびリソース間の関係を説明するテンプレートを作成できます。 ROSは、テンプレートに基づいてすべてのリソースを自動的に作成および構成し、自動デプロイとO&Mを実装します。詳細については、「ROSとは何ですか?」をご参照ください。
ROSを使用してKMSのAPI操作を呼び出すことはできません。
テラフォーム
Terraformは、クラウドインフラストラクチャとリソースを安全かつ効率的にプレビュー、設定、管理するために使用されるオープンソースツールです。 TerraformはROSと同様に機能します。 Terraformは、テンプレートを解釈してAPI操作を呼び出します。 詳細については、「Terraformとは何ですか?」をご参照ください。
詳細については、「Overview」をご参照ください。
カスタムAPIカプセル化
ネイティブHTTP呼び出しを行うには、カスタムリクエストを作成してリクエストに署名する必要があります。 署名メカニズムの詳細については、「関数別の操作のリスト」および「リクエスト構文と署名メソッドV3」をご参照ください。
使用上の注意
Alibaba Cloudアカウントが開始できる1秒あたりのクエリ数 (QPS) は、API操作によって異なります。 詳細については、各操作のAPIリファレンスのQPS制限セクションをご参照ください。
説明Alibaba Cloudアカウントに属するすべてのRAMユーザーは、Alibaba CloudアカウントのQPSクォータを共有します。
KMSのAPI操作を呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて入力パラメーターと値が有効かどうかを確認します。 詳細については、「一般的なエラーコード」をご参照ください。
Alibaba Cloud OpenAPI Diagnosticsプラットフォームを使用して、返されたリクエストIDまたはSDKエラーメッセージに基づいてセルフサービス診断を実行します。