Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ DataArts Studio/ API Reference/ Appendix/ Common Message Headers

Common Message Headers

Updated on 2024-11-06 GMT+08:00

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

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.

  • You do not need to set this field when calling a CDM or DIS API.
  • This field is mandatory when there are multiple DataArts Studio instances during a call to a DataArts Factory API.

    This field is optional when there is only one DataArts instance. 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.

  • This header is mandatory for calling the APIs of other modules. Otherwise, API calls will fail.

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

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback