Common Message Headers
Common request header fields
Table 1 describes common request headers.
Field |
Description |
Mandatory |
Example |
---|---|---|---|
Content-Type |
Request body type or format. Its default value is application/json. |
Yes |
application/json |
Content-Length |
Specifies the length of the request body. The unit is byte. |
No |
3495 |
X-Language |
Request language |
No |
en_us |
X-Auth-Token |
Specifies a user token. The user token is the value returned by the API used to obtain a user token. This API is the only API that does not require authentication. The token is the value of X-Subject-Token in the response header. |
This field is mandatory for token authentication. |
The following is part of an example token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
Authorization |
Authentication information. When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request. |
This field is mandatory for AK/SK-based authentication. |
None |
X-Sdk-Date |
Time when the request is sent. The format is YYYYMMDD'T'HHMMSS'Z'. The value is the current GMT time of the system. When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request. |
This field is mandatory for AK/SK-based authentication. |
20150907T101459Z |
Host |
Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of hostname[:port]. If the port number is not specified, the default port is used. The default port number for HTTPS is 443. |
This field is mandatory for AK/SK-based authentication. |
code.test.com or code.test.com:443 |
X-Project-Id |
Subproject ID. Obtain the project ID by following the instructions in Project ID and Account ID. |
This field is mandatory for calling service APIs that use AK/SK authentication in subprojects. |
e9993fc787d94b6c886cbaa340f9c0f4 |
X-Domain-ID |
Domain ID. Obtain the domain ID by following the instructions in Project ID and Account ID. |
This field is mandatory for calling global APIs that use AK/SK authentication. |
0a2f5e28af00f3850f31c00f31e884e0 |
workspace |
Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID. |
|
d1cd7861478748a6925bc02f47c69279 |
X-Dlm-Type |
DataArts DataService edition, which is Exclusive |
This parameter is mandatory for calling DataArts DataService APIs. |
EXCLUSIVE: exclusive edition |
Common response headers
Table 2 describes common response headers.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot