専用ホスト(DDH)API を呼び出すには、HTTP または HTTPS GET リクエストを DDH エンドポイントに送信する必要があります。関連する API 操作に固有のリクエストパラメータを追加する必要があります。API 操作を呼び出すと、システムはレスポンスを返します。リクエストとレスポンスは UTF-8 でエンコードされます。
リクエスト構文
DDH の API 操作では、リモートプロシージャコール(RPC)プロトコルが使用されます。HTTP または HTTPS GET リクエストを送信することで、API 操作を呼び出すことができます。
次のリクエスト構文が使用されます。
http(s)://Endpoint/?Action=xx&Parameters各項目の説明:
エンドポイント: DDH API のエンドポイントは ecs.aliyuncs.com です。
アクション: 実行する操作の名前。たとえば、1 つ以上の専用ホストの詳細を照会するには、Action パラメータを DescribeDedicatedHosts に設定する必要があります。
バージョン: API のバージョン。DDH API のバージョンは 2014-05-26 です。
パラメータ: 操作のリクエストパラメータ。複数のパラメータはアンパサンド(
&)で区切ります。リクエストパラメータには、共通パラメータと操作固有のパラメータが含まれます。共通パラメータには、API バージョン番号と ID 検証情報が含まれます。詳細については、「共通パラメータ」および「署名メソッド」をご参照ください。
次の例では、DescribeDedicatedHosts 操作を呼び出して、リージョン内の専用ホストの詳細を照会します。
サンプルリクエストは、読みやすくするためにフォーマットされています。
http(s)://ecs.aliyuncs.com/?Action=DescribeDedicatedHost
&Format=xml
&Version=2014-05-26
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2012-06-01T12:00:00Z
&RegionId=cn-hangzhou
...レスポンス
レスポンスは JSON または XML 形式で返されます。デフォルトのレスポンス形式は XML です。レスポンス形式を変更するには、リクエストで共通リクエストパラメータ Format を設定します。詳細については、「共通パラメータ」をご参照ください。API リファレンスで提供されているサンプルレスポンスは、読みやすくするために改行とインデントでフォーマットされています。実際のレスポンスには改行やインデントはありません。
API レスポンスは HTTP レスポンス形式を使用します。200 ~ 299 の HTTP ステータスコードは、呼び出しが成功したことを示します。例:
XML 形式
<?xml version="1.0" encoding="UTF-8"?> <!--レスポンスのルートノード--> <ActionResponse> <!--返されたリクエストタグ--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--返された結果--> </ActionResponse>JSON 形式
{ "RequestId": "4C467B38-3910-447D-87BC-AC049166F216" /* 返された結果 */ }
API 呼び出しに失敗した場合、呼び出しのレスポンスには、エラーコード、エラーメッセージ、リクエスト ID、および HTTP ステータスコード 4xx または 5xx が含まれます。例:
XML 形式
<?xml version="1.0" encoding="UTF-8"?><!--レスポンスのルートノード--> <Error> <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--リクエスト ID--> <HostId>ecs.aliyuncs.com</HostId> <!--サービスノード--> <Code>MissingParameter.CommandId</Code> <!--エラーコード--> <Message>The input parameter “CommandId” that is mandatory for processing this request is not supplied.</Message> <!--エラーメッセージ--> </Error>JSON 形式
{ "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* リクエスト ID */ "HostId": "ecs.aliyuncs.com", /* サービスノード */ "Code": "MissingParameter.CommandId", /* エラーコード */ "Message": "The input parameter “CommandId” that is mandatory for processing this request is not supplied." /* エラーメッセージ */ }
API操作の呼び出し時にエラーが発生した場合は、返されたエラーコードに基づいてトラブルシューティングを行うことができます。詳細については、「一般的なエラーコード」をご参照ください。または、API エラーセンター にアクセスしてください。