Common parameters
Every TSDB Operations and Maintenance (O&M) API call requires a set of public request parameters. After the call completes, a set of public response parameters is returned regardless of whether the call succeeded or failed.
Public request parameters
Include the following parameters in every O&M API request.
| Parameter | Type | Required | Description |
|---|---|---|---|
| Action | String | Yes | Name of the API operation to call. |
| Version | String | Yes | API version in YYYY-MM-DD format. The current version is 2017-06-01. |
| AccessKeyId | String | Yes | Your Alibaba Cloud AccessKey ID. |
| Signature | String | Yes | The request signature. |
| SignatureMethod | String | Yes | Signature algorithm. Currently, only HMAC-SHA1 is supported. |
| SignatureVersion | String | Yes | Signature algorithm version. The current version is 1.0. |
| SignatureNonce | String | Yes | A unique random string to prevent replay attacks. Use a different value for each request. |
| Timestamp | String | Yes | Request timestamp in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ), using UTC time. For example, 2013-08-15T12:00:00Z. |
| RegionId | String | Yes | The region where your TSDB instance resides. |
| Format | String | No | Format of the returned data. Valid values: JSON (recommended), XML. |
Public response parameters
Every API response includes a RequestId field — a globally unique identifier for that request. Use RequestId when troubleshooting API issues.
HTTP status codes
| Status code | Meaning |
|---|---|
2xx | The request succeeded. |
4xx | The request failed due to a client error. Check the error code and message in the response body. |
5xx | The request failed due to a server error. Contact Alibaba Cloud Customer Service with the HostId and RequestId. |
Successful response format
A successful response contains RequestId and the operation-specific data. Both JSON and XML formats are supported. JSON is recommended.
JSON
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
...
}XML
<?xml version="1.0" encoding="utf-8"?>
<!-- Root node of the response data -->
<API operation name+Response>
<!-- Request tag -->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!-- Response data -->
...
</API operation name+Response>Response examples in this documentation are formatted for readability. Actual responses do not contain line breaks or indentation.
Error response format
When a request fails, the response body contains the following fields.
| Field | Type | Always returned | Description |
|---|---|---|---|
RequestId | String | Yes | The request ID. Provide this to Alibaba Cloud Customer Service when reporting issues. |
HostId | String | Yes | The ID of the endpoint that handled the request. |
Code | String | Yes | The error code identifying the type of error. |
Message | String | Yes | A human-readable description of the error. |
JSON
{
"RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
"HostId": "hitsdb.aliyuncs.com",
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."
}XML
<?xml version="1.0" encoding="UTF-8"?>
<Error>
<RequestId>8906582E-6722-409AA6C4-0E7863B733A5</RequestId>
<HostId>hitsdb.aliyuncs.com</HostId>
<Code>UnsupportedOperation</Code>
<Message>The specified action is not supported.</Message>
</Error>If you cannot identify the cause of an error, contact Alibaba Cloud Customer Service and provide the HostId and RequestId.