このトピックでは、Dedicated Host (DDH) のすべてのAPI操作に必要なリクエストパラメーター、レスポンスパラメーター、および一般的なエラーコードについて説明します。
共通リクエストパラメーター
| パラメーター | データ型 | 必須／任意 | 例 | 説明 |
|---|---|---|---|---|
| 操作 | String | 必須 | AllocateDedicatedHosts | 実行する操作です。 詳細については、「機能別操作一覧」をご参照ください。 |
| AccessKeyId | String | 必須 | key-test | Alibaba Cloud から提供される AccessKey ID です。 AccessKeyペアは、API操作を呼び出すために使用されます。 ユーザー名とパスワードは、Elastic
Compute Service (ECS) コンソールへのログインに使用されます。
詳細については、「AccessKey の作成」をご参照ください。 |
| Signature | String | 必須 | Pc5WB8gokVn0xfeu % 2FZV % 2BiNM1dgI % 3D | 現在のリクエストの署名文字列。 詳細については、「t1605866.html#concept_2022720」をご参照ください。 |
| SignatureMethod | String | 必須 | HMAC-SHA1 | 署名文字列の暗号化方式を設定します。 値を HMAC-SHA1 に設定します。 |
| SignatureVersion | String | 必須 | 1.0 | 署名暗号化アルゴリズムのバージョンを設定します。 値を 1.0 に設定します。 |
| SignatureNonce | String | 必須 | 15215528852396 | 反射攻撃を防ぐための、一意の乱数を設定します。 各リクエストで異なる乱数を使用する必要があります。 |
| タイムスタンプ | String | 必須 | 2018-01-01T12:00:00Z | リクエストのタイムスタンプ。
リクエストのタイムスタンプ (例: |
| Version | String | 必須 | 2014-05-26 | API のバージョン番号。 値はYYYY-MM-DD形式でなければなりません。 値を2014-05-26に設定します。 |
| 形式 | String | 任意 | xml | レスポンスを返す形式を設定します。 有効な値 : JSON と XML。
デフォルト値：XML。 |
リクエストのサンプル:
https://ecs.aliyuncs.com/?Action=AllocateDedicatedHosts
&Format=xml
&バージョン=2014-05-26
&シグネチャー=Pc5WB8gokVn0xfeu % 2FZV % 2BiNM1dgI % 3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=キーテスト
&タイムスタンプ=2018-01-01T12:00:00Z
...共通レスポンスパラメーター
レスポンスデータは JSON 形式または XML 形式のいずれかで返されます。 リクエストでレスポンスの形式を指定できます。 デフォルトのレスポンス形式は XML
です。 すべての応答は、呼び出しが成功したかどうかに関係なく、一意のRequestIDを返します。
2xxステータスコードは、呼び出しが成功したことを示します。4xxまたは5xxステータスコードは、呼び出しの失敗を示します。
レスポンスの例
- XML 形式
<?xml version="1.0" encoding="utf-8"?> <!--Result Root Node--> <Interface Name+Response> <!-- Return Request Tag --> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!-- 結果データを返す --> <Interface Name+Response> - JSON 形式
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /* 結果データを返す * / }
一般的なエラーコード
| エラーコード | HTTP ステータスコード | エラーメッセージ |
|---|---|---|
| IdempotentParameterMismatch | 400 | リクエストは更新されたパラメーターで再試行されます。 |
| IllegalTimestamp | 400 | The input parameter "Timestamp" that is mandatory for processing this request is not supplied. |
| IncompleteSignature | 400 | The request signature does not conform to Aliyun standards. |
| InsufficientBalance | 400 | Your account does not have enough balance. |
| InvalidAccessKeyId.NotFound | 400 | 指定されたアクセスキーIDは存在しません。 |
| InvalidOwner | 400 | OwnerId and OwnerAccount can't be used at one API access. |
| InvalidOwnerAccount | 400 | The specified OwnerAccount is not valid. |
| InvalidOwnerId | 400 | The specified OwnerId is not valid. |
| InvalidParamater | 400 | 指定されたパラメーター "SignatureMethod" は無効です。 |
| InvalidParamater | 400 | 指定されたパラメーター "SignatureVersion" は無効です。 |
| InvalidParameter | 400 | 指定されたパラメータは無効です。 |
| InvalidParameter | 400 | The specified parameter "Action or Version" is not valid. |
| InvalidParameter.IsNull | 400 | 必須パラメーターはnullではありません。 |
| MissingParameter | 400 | このリクエストを処理するために必須の入力パラメータ「Action」は指定されていません。 |
| MissingParameter | 400 | このリクエストの処理に必須の入力パラメーター "AccessKeyId" が指定されていません。 |
| MissingParameter | 400 | リクエストの処理に必須の入力パラメータ「Signature」は指定されていません。 |
| MissingParameter | 400 | この要求を処理するために必須の入力パラメータ「TimeStamp」は指定されていません。 |
| MissingParameter | 400 | この要求を処理するために必須の入力パラメータ「Version」は指定されていません。 |
| SignatureNonceUsed | 400 | リクエスト署名nonceが使用されています。 |
| Throttling | 400 | 短時間でリクエストが多すぎました。リクエストの抑制により、リクエストは拒否されます。 |
| UnsupportedParameter | 400 | パラメーターはサポートされていません。 |
| UnknownError | 400 | 不明なエラーにより、リクエスト処理が失敗しました。 |
| ChargeTypeViolation | 403 | この操作は、インスタンスの課金タイプが原因で許可されていません。 |
| Forbidden.AccessKeyDisabled | 403 | アクセスキーは無効です。 |
| Forbidden.NotSupportRAM | 403 | This action does not support accessed by RAM mode. |
| Forbidden.RAM | 403 | 指定されたリソースを操作する権限がないユーザー、またはこのAPIがRAMをサポートしていません。 |
| Forbidden.RiskControl | 403 | この操作は Aliyun Risk Control システムによって禁止されています。 |
| Forbidden.SubUser | 403 | The specified action is not available for you. |
| Forbidden.Unauthorized | 403 | User not authorized to operate on the specified resource. |
| InvalidAccount.NotFound | 403 | 指定されたアカウントは存在しません。 |
| InvalidAction | 403 | 指定されたアクションは無効です。 |
| InvalidIdempotenceParameter.Mismatch | 403 | 指定されたパラメータは以前とは異なります。 |
| InvalidParameter.OwnerAccount | 403 | OwnerAccountが無効です。 |
| InvalidParameter.ResourceOwnerAccount | 403 | ResourceOwnerAccount is Invalid. |
| LastTokenProcessing | 403 | 最後のトークンリクエストは処理中です。 |
| MissingParameter | 403 | このリクエストの処理に必須の入力パラメーターOwnerId、OwnerAccountが指定されていません。 |
| RealNameAuthenticationError | 403 | Your account has not passed the real-name authentication yet. |
| UnsupportedHTTPMethod | 403 | サポートされていないメソッドです。 |
| InvalidDiskId.NotFound | 404 | 指定された DiskId は存在しません。 |
| InvalidImageId.NotFound | 404 | The specified ImageId does not exist. |
| InvalidInstanceId.NotFound | 404 | 指定されたInstanceIdは存在しません。 |
| InvalidRegionId.NotFound | 404 | The specified RegionId does not exist. |
| InvalidSecurityGroupId.NotFound | 404 | The specified SecurityGroupId does not exist. |
| InvalidSnapshotId.NotFound | 404 | 指定された SnapshotId は存在しません。 |
| OperationConflict | 409 | 以前のリクエストとの競合により、リクエストが拒否されました。 |
| InternalError | 500 | The request processing has failed due to some unknown error, exception or failure. |
| ServiceUnavailable | 503 | The request has failed due to a temporary failure of the server. |
| ServiceUnavailable.RegionMaintaining | 503 | 選択したリージョンでシステムメンテナンスが進行中です。数分待ってから再試行してください。 |