文档首页/ 云客服/ 用户接入——网页客户端接入（RESTful）/ 概述/ RESTful接口格式/ 请求消息
更新时间：2024-03-05 GMT+08:00
查看PDF

请求消息

一个请求消息通常由以下几部分组成：请求行、请求报头、请求正文(可选)。请求消息格式如表1所示。

表1 请求消息格式

HTTP(s)请求报文

HTTP(s)请求行

Method Request-URI HTTP-Version

说明：

Method和Request-URI之间有空格，Request-URI和HTTP-Version之间有空格。HTTP-Version后有回车符。

请求头

Content-Type:application/json;charset=UTF-8

空行

CRLF（回车符）

消息体（可选）

业务请求消息(JSON描述)

请求行

请求行以一个方法符号开头，以空格分开，后面跟着请求的URI和协议的版本，格式如下：

Method Request-URI HTTP-Version CRLF

  • Method表示请求方法。例如，GET、POST、PUT、DELETE。
  • Request-URI是一个统一资源标识符。例如，通用的URI格式为https://10.10.10.2:9443/balancemgmt/v1/balance
  • HTTP-Version表示请求的HTTP协议版本。例如，HTTP/1.1。
  • CRLF表示回车和换行，除了作为结尾的CRLF外，不允许出现单独的CR或LF字符。

请求报头

请求报头由若干头域构成，每个头域由一个域名，冒号(: )和域值组成。虚拟化层的请求报头一般包含以下报头：

  • Host: https://<hostname>[:<port>]

    其中，https对应的port默认值为9443。

  • Content-Type: application/json

    表示消息正文的类型为JSON。

  • Accept: application/json;version=1.0
  • Accept-Language:zh_CN

    响应消息中语言类型。支持zh_CN（简体中文）和en_US（英文）。

  • Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

    鉴权字段，通过userid、password进行鉴权。

  • AccessKeyId: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    帐号或用户的访问标识，用于标识创建资源的属主。此字段为可选字段，调用C3业务接口需必须填，调用C3运维接口可不填。

请求正文

请求正文为JSON格式的文本。具体请查看后续章节各个接口的定义。

父主题： RESTful接口格式