This topic describes the request parameters, response parameters, and common error codes that are required for all API operations of Dedicated Host (DDH).
Common request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | AllocateDedicatedHosts | The operation that you want to perform. For more information, see List of operations by function. |
AccessKeyId | String | Yes | key-test | The AccessKey ID provided to you by Alibaba Cloud. AccessKey pairs are used to call
API operations. Usernames and passwords are used to log on to the Elastic Compute
Service (ECS) console.
For more information, see Obtain an AccessKey pair. |
Signature | String | Yes | Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D | The signature string of the current request. For more information, see Signature method. |
SignatureMethod | String | Yes | HMAC-SHA1 | The encryption method of the signature string. Set the value to HMAC-SHA1. |
SignatureVersion | String | Yes | 1.0 | The version of the signature encryption algorithm. Set the value to 1.0. |
SignatureNonce | String | Yes | 15215528852396 | A unique, random number used to prevent replay attacks. You must use different numbers for different requests. |
Timestamp | String | Yes | 2018-01-01T12:00:00Z | The timestamp of the request.Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
The timestamp of the request, for example, |
Version | String | Yes | 2014-05-26 | The version number of the API. The value must be in the YYYY-MM-DD format. Set the value to 2014-05-26. |
Format | String | No | xml | The format in which to return the response. Valid values: json and xml.
Default value: xml. |
Sample requests:
https://ecs.aliyuncs.com/?Action=AllocateDedicatedHosts
&Format=xml
&Version=2014-05-26
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-01-01T12:00:00Z
...
Common response parameters
Responses can be returned in either the JSON or XML format. You can specify the response
format in the request. The default response format is XML. Every response returns
a unique RequestID regardless of whether the call is successful.
- A
2xx
status code indicates a successful call. - A
4xx
or5xx
status code indicates a failed call.
Sample responses
- XML format
<?xml version="1.0" encoding="utf-8"?> <!--Result Root Node--> <Interface Name+Response> <!--Return Request Tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--Return Result Data--> <Interface Name+Response>
- JSON format
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216" /*Return Result Data*/ }
Common error codes
Error code | HTTP status code | Error message |
---|---|---|
IdempotentParameterMismatch | 400 | The request is retried with updated parameters. |
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 | The specified Access Key ID does not exist. |
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 | The specified parameter "SignatureMethod" is not valid. |
InvalidParamater | 400 | The specified parameter "SignatureVersion" is not valid. |
InvalidParameter | 400 | The specified parameter is not valid. |
InvalidParameter | 400 | The specified parameter "Action or Version" is not valid. |
InvalidParameter.IsNull | 400 | The required parameter must be not null. |
MissingParameter | 400 | The input parameter "Action" that is mandatory for processing this request is not supplied. |
MissingParameter | 400 | The input parameter "AccessKeyId" that is mandatory for processing this request is not supplied. |
MissingParameter | 400 | The input parameter "Signature" that is mandatory for processing the request is not supplied. |
MissingParameter | 400 | The input parameter "TimeStamp" that is mandatory for processing this request is not supplied. |
MissingParameter | 400 | The input parameter "Version" that is mandatory for processing this request is not supplied. |
SignatureNonceUsed | 400 | The request signature nonce has been used. |
Throttling | 400 | You have made too many requests within a short time; your request is denied due to request throttling. |
UnsupportedParameter | 400 | The parameters is unsupported. |
UnknownError | 400 | The request processing has failed due to some unknown error. |
ChargeTypeViolation | 403 | The operation is not permitted due to charge type of the instance. |
Forbidden.AccessKeyDisabled | 403 | The Access Key is disabled. |
Forbidden.NotSupportRAM | 403 | This action does not support accessed by RAM mode. |
Forbidden.RAM | 403 | User not authorized to operate on the specified resource, or this API doesn't support RAM. |
Forbidden.RiskControl | 403 | This operation is forbidden by Aliyun RiskControl system. |
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 | The specified Account does not exist. |
InvalidAction | 403 | Specified action is not valid. |
InvalidIdempotenceParameter.Mismatch | 403 | The specified parameters are different from before. |
InvalidParameter.OwnerAccount | 403 | OwnerAccount is Invalid. |
InvalidParameter.ResourceOwnerAccount | 403 | ResourceOwnerAccount is Invalid. |
LastTokenProcessing | 403 | The last token request is processing. |
MissingParameter | 403 | The input parameter OwnerId,OwnerAccount that is mandatory for processing this request is not supplied. |
RealNameAuthenticationError | 403 | Your account has not passed the real-name authentication yet. |
UnsupportedHTTPMethod | 403 | This http method is not supported. |
InvalidDiskId.NotFound | 404 | The specified DiskId does not exist. |
InvalidImageId.NotFound | 404 | The specified ImageId does not exist. |
InvalidInstanceId.NotFound | 404 | The specified InstanceId does not exist. |
InvalidRegionId.NotFound | 404 | The specified RegionId does not exist. |
InvalidSecurityGroupId.NotFound | 404 | The specified SecurityGroupId does not exist. |
InvalidSnapshotId.NotFound | 404 | The specified SnapshotId does not exist. |
OperationConflict | 409 | Request was denied due to conflict with a previous request. |
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 | System maintenance is in progress on the selected region, please wait a few minutes before trying again. |