更新时间:2024-11-06 GMT+08:00

公共消息头

公共请求消息头

公共请求消息头如表1所示。

表1 公共请求消息头

名称

描述

是否必选

示例

Content-Type

消息体的类型(格式),默认取值为“application/json”

application/json

Content-Length

请求body长度,单位为Byte。

3495

X-Language

请求语言。

en_us

X-Auth-Token

用户Token。用户Token是调用获取用户Token接口的响应值,因此调用获取用户Token接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

使用Token认证时该字段必选。

注:以下仅为Token示例片段

MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

Authorization

签名认证信息。

当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。

使用AK/SK认证时必选。

-

X-Sdk-Date

请求的发生时间,格式为(YYYYMMDD'T'HHMMSS'Z'),取值为当前系统的GMT时间。

当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。

使用AK/SK认证时必选。

20150907T101459Z

Host

请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。

使用AK/SK认证时必选。

code.test.com

or

code.test.com:443

X-Project-Id

子项目ID。请参考项目ID和账号ID章节获取项目ID。

调用在子项目中的服务接口,并使用AK/SK认证时必选。

e9993fc787d94b6c886cbaa340f9c0f4

X-Domain-ID

账号ID。请参考项目ID和账号ID章节获取账号ID。

调用全局服务接口,并使用AK/SK认证时必选。

0a2f5e28af00f3850f31c00f31e884e0

workspace

工作空间id,获取方式请参见实例ID和工作空间ID

  • 调用批量数据迁移或实时数据接入API时无需配置。
  • 调用数据开发API时,有多个DataArts Studio实例时必选。

    只有一个DataArts实例时可选。不填写则默认查询default工作空间数据,如需查询其他工作空间需要带上该消息头。

  • 调用其他组件API时必选,否则会调用失败。

d1cd7861478748a6925bc02f47c69279

X-Dlm-Type

数据服务版本类型,用于请求数据服务时,指定专享版

调用数据服务接口时必选

专享版: EXCLUSIVE

公共响应消息头

公共响应消息头如表2所示。

表2 公共响应消息头

参数名

说明

Content-Length

响应消息体的字节长度,单位为Byte。

Date

系统响应的时间。

Content-type

发送的实体的MIME类型。