构造请求
本节介绍REST API请求的组成，并以调用EDS服务的查询指定连接器下的offer列表接口为例说明如何调用API。
请求URI
请求URI由如下部分组成。
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
参数 |
说明 |
|---|---|
URI-scheme |
传输请求的协议，当前所有API均采用HTTPS协议。 |
Endpoint |
承载REST服务端点的服务器域名或IP，不同服务在不同区域时，对应Endpoint不同，当前EDS只在“华北-北京四”部署，Endpoint为“eds.cn-north-4.myhuaweicloud.com”。 |
resource-path |
资源路径，也即API访问路径。从具体API的URI模块获取，例如“查询指定连接器下的offer列表”API的resource-path为“/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers”。 |
query-string |
查询参数，可选，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。多个查询参数之间使用“&”隔开。 |
例如您需要获取“华北-北京四”区域指定连接器下的offer列表，则需使用“华北-北京四”区域的Endpoint（eds.cn-north-4.myhuaweicloud.com），并在查询指定连接器下的offer列表的URI部分找到resource-path（/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers），拼接起来如下所示。
https://eds.cn-north-4.myhuaweicloud.com/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
请求方法
HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。
方法 |
说明 |
|---|---|
GET |
请求服务器返回指定资源。 |
PUT |
请求服务器更新指定资源。 |
POST |
请求服务器新增资源或执行特殊操作。 |
DELETE |
请求服务器删除指定资源，如删除对象等。 |
HEAD |
请求服务器资源头部。 |
PATCH |
请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 |
在查询指定连接器下的offer列表的URI部分，您可以看到其请求方法为“GET”，则其请求为：
GET https://eds.cn-north-4.myhuaweicloud.com/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers
请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
详细的公共请求消息头字段请参见表3。
参数名 |
说明 |
是否必选 |
示例 |
|---|---|---|---|
Content-type |
消息体的类型（格式），默认取值为“application/json”。 |
是 |
application/json |
Content-Length |
请求body长度，单位为Byte。 |
POST/PUT请求必填，GET不能包含。 |
3495 |
X-Auth-Token |
用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 |
是 使用Token认证时该字段必选。 |
注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
对于查询指定连接器下的offer列表接口，需要添加“Content-Type”，添加消息头后的请求如下所示。
GET https://eds.cn-north-4.myhuaweicloud.com/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers
Content-Type:application/json
请求消息体（可选）
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。如果请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于查询指定连接器下的offer列表接口，可以从接口的请求部分看到所需的请求参数及参数说明，由于其为GET操作，所以没有消息体。
