Common Message Headers

Common request header fields

Table 1 describes common request headers.

Table 1 Common request header fields

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	Specifies the request language.	No	en_us
X-Project-Id	Specifies a project ID. Obtain the project ID by following the instructions in Project ID and Account ID.	No	e9993fc787d94b6c886cbaa340f9c0f4
X-Auth-Token	Specifies a user token. The user token is a response to the API used to obtain a user token. This API is the only one 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
X-Sdk-Date	Time when the request is sent. The time is in YYYYMMDD'T'HHMMSS'Z' format. The value is the current GMT time of the system.	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
Authorization	Authentication information. The value can be obtained from the request signing result.	This field is mandatory for AK/SK-based authentication.	-
workspace	Workspace ID. For details about how to obtain it, see DataArts Studio Instance ID and Workspace ID.	You do not need to set this field when calling a CDM API because in that case, only the default workspace can be used. This field is mandatory when there are multiple DataArts Studio instances during a call to a data development API. This field is optional when there is only one DataArts Studio instance. If this field is not specified, data in the default workspace is queried by default. To query data in other workspaces, include this field in the request header.	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.

Table 2 Common response headers

Parameter	Description
Content-Length	Length of the response body. The unit is byte.
Date	Time when a response is returned
Content-type	Request body MIME type

last updated: 2024-11-13 13:47 UTC - commit: db9c60a6c98025320fa32706a5e58cd02cf7d7f1