製品コンセプト
適用シーン
API Explorerの使用
Tencent Cloud API Explorerツールは自動化ツールであり、現在CVM、VPC、CBSなどのTencent Cloud製品のAPI呼び出しの自動化をサポートしています。Java、Python、Node.js、PHP、GOおよび.NET言語のSDKコードの自動生成、オンライン呼び出し、実際のリクエストの送信、署名文字列の自動生成などの機能を実現でき、SDKの使用難易度を低減します。
API Explorerツールの詳細な紹介
このドキュメントでは、API Explorerツールの全体ページを左から右の順序で順に詳細に説明します。以下の図に示されている通りです：
1. 製品リージョン：現在サポートされているすべての製品。
2. 製品APIエリア：現在の製品においてサポートされているすべての機能API。
3. API名：選択されたAPI名。
4. 製品バージョン：各製品バージョンには一定の違いがあります。詳細は各APIドキュメントを参照してください。図はCVMAPIバージョン 2017-03-12です。
5. キーペア（SecretId、SecretKey）：アカウントのセキュリティ認証情報を入力します。【キーを表示】をクリックして取得できます。
注意：
シークレットキーはアカウントの身分と所有している権限を表し、ログインパスワードと同等です。絶対に他人に漏洩しないでください。
6. 署名に必要なパラメータ：その他のオプションをクリックすると、署名文字列生成、署名文字列検証などの機能に必要なパラメータを表示できます。各製品APIに必要なパラメータには一定の違いがあります。詳細は各APIドキュメントを参照してください。CVMの署名に必要なパラメータは以下の通りです：
Timestamp（署名文字列生成の検証時のみ有効）：現在のUNIXタイムスタンプで、秒単位で正確に、APIリクエストを開始した時間を記録するために使用されます。
Timestampは現在のシステム時間でなければならず、また、システム時間と標準時間が同期していることを確保する必要があります。5分以上差がある場合、リクエスト失敗が発生します。長時間標準時間と同期しない場合、一定期間経過後にリクエストが失敗し、署名の期限切れエラーが返される可能性があります。
Token（署名文字列生成の検証時のみ有効）：ユーザー認証に使用されます。各製品によってこのパラメータの要件は異なる場合があります。必要に応じて取得方法を明記します。詳細は各APIドキュメントを参照してください。
リクエストメソッド（署名文字列生成の検証時のみ有効）：デフォルトはPOSTリクエストです。APIドキュメントを参照の上、選択してください。
Endpoint（署名文字列生成の検証時のみ有効）：アクセスリージョンを選択します。デフォルトでは最寄りのリージョンを選択します。
7. APIに必要なパラメータ：APIに必要なパラメータのみを表示します。「必須パラメータのみ表示」にチェックを入れてフィルタリングできます。具体的なパラメータ説明は、右側の【パラメータ説明】を選択することで確認できます。
8. 機能エリア：
コード生成：この機能により多言語バージョンのコードを自動生成でき、使用の難易度を低減します。
オンライン呼び出し：パラメータを入力後、リクエスト送信を選択すると、システムは左側に入力したパラメータを対応するAPIに送信します。この操作は実際の操作と同等であり、同時にシステムはリクエスト結果、レスポンスヘッダーなどの関連情報を表示します。
署名文字列生成：この機能により署名文字列を自動生成できます。デフォルトではAPI 3.0 v3バージョンを使用します。必要に応じて他のバージョンを選択できます。下図の通りです：
9. サブ機能エリア：言語バージョンを切り替えることができ、対応するコードを生成します。
10. レスポンスエリア：ここに生成されたコード、リクエスト結果などのレスポンス情報が表示されます。
11. SDK 使用説明：SDKの詳細情報（必要な環境や呼び出しサンプルなど）を確認したい場合は、対応するSDK使用説明を参照してください。
APIの呼び出し
1. 個人のキー（SecretId、SecretKey）を取得し、対応する位置に入力してください。
2. 必要なパラメータを入力してください。右側の機能エリアにあるパラメータ説明を選択して、APIの具体的なパラメータ情報を確認できます。
3. 右側の機能エリアにあるオンライン呼び出し > リクエスト送信を選択すると、レスポンスエリアでリクエスト結果を確認できます。
署名文字列を生成する
1. 個人のキー（SecretId、SecretKey）を取得し、対応する位置に入力してください。
2. （オプション）署名に必要なパラメータを入力してください。必要に応じて入力できます。入力しない場合、システムは署名文字列生成時に自動的に署名に必要なパラメータを入力します。
3. APIのパラメータを入力してください。右側の機能エリアにあるパラメータ説明を選択して、APIの具体的なパラメータ情報を確認できます。
4. 右側の機能エリアで署名文字列生成＞シグネチャ生成を選択すると、レスポンスエリアでシグネチャの詳細な手順と結果を確認できます。
関連問題
APIシグネチャをツールで検証する方法
以下のようなエラーメッセージが表示された場合、API Explorerツールを使用して検証できます：
[TencentCloudSDKException] code:AuthFailure.SecretIdNotFound message:The SecretId is not found, please ensure that your SecretId is correct. requestId:234a93fe-9024-488e-87a8-48e4f3c3548e
1. パラメータをAPI Explorerツールに入力してください。Timestampなどの可変パラメータは、検証対象のシグネチャ（APIエラーシグネチャ）で使用されたパラメータと一致させてください。機能エリアの署名文字列生成＞シグネチャ生成を選択してください。
2. レスポンスエリアで署名ステップと結果を取得した後、前後のデータ比較を行うことができます。
シグネチャエラー
シグネチャの過程でエラーが発生した場合、以下のシグネチャ失敗のエラーコードを受信する可能性があります。実際の状況に応じて処理してください：
エラーコード | エラー説明 |
AuthFailure.SignatureExpire | シグネチャの期限切れです。 |
AuthFailure.SecretIdNotFound | キーが存在しません。 |
AuthFailure.SignatureFailure | シグネチャエラーです。 |
AuthFailure.TokenFailure | tokenエラーです。 |
AuthFailure.InvalidSecretId | キーが無効です（TencentCloud APIキータイプではありません）。 |
お問い合わせ
使用中に問題を発見した場合、機能エリアの問題フィードバックを選択して報告できます。
また、右下の
フィードバック