构造请求
本节介绍REST API请求的组成，以调用检索共享资源权限列表接口说明如何调用API。
您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/101580。
请求URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
|
参数 |
说明 |
|---|---|
|
URI-scheme |
传输请求的协议，当前所有API均采用HTTPS协议。 |
|
Endpoint |
承载REST服务端点的服务器域名或IP，不同服务在不同区域，Endpoint不同，可以从地区和终端节点处获取。例如RAM服务的Endpoint为ram.myhuaweicloud.com。 |
|
resource-path |
资源路径，即API访问路径。从具体API的URI模块获取，例如“检索指定资源类型的共享资源权限列表”API的resource-path为“/v1/permissions”。 |
|
query-string |
查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 |
例如您需要检索指定资源类型的共享资源权限列表，则需使用RAM的Endpoint（ram.myhuaweicloud.com），并在检索共享资源权限列表的URI部分找到resource-path（/v1/permissions），拼接起来如下所示。
https://ram.myhuaweicloud.com/v1/permissions
请求方法
HTTP方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。
|
方法 |
说明 |
|---|---|
|
GET |
请求服务器返回指定资源。 |
|
PUT |
请求服务器更新指定资源。 |
|
POST |
请求服务器新增资源或执行特殊操作。 |
|
DELETE |
请求服务器删除指定资源。 |
请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。详细的公共请求消息头字段请参见表3。
如下公共消息头需要添加到请求中。
|
消息头名称 |
描述 |
是否必选 |
|---|---|---|
|
Authorization |
请求消息中可带的签名信息。AK/SK认证的详细说明请参见：AK/SK认证。 类型：String 默认值：无。 |
是 |
|
Content-Type |
资源内容的类型，例如：application/json。 类型：String 默认值：无。 |
是 |
|
X-Sdk-Date |
请求发起端的日期和时间，例如：20221107T020014Z。 类型：String 默认值：无。 |
是 |
|
Host |
表明主机地址。例如：ram.myhuaweicloud.com。 类型：String 默认值：无。 |
是 |
API支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见：AK/SK认证。
对于检索共享资源权限列表接口，请求如下所示。
GET https://ram.myhuaweicloud.com/v1/permissions content-type: application/json X-Sdk-Date: 20230330T021902Z host: ram.myhuaweicloud.com Authorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx
请求消息体（可选）
请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
