更新时间:2025-09-25 GMT+08:00
分享

构造请求

本节介绍REST API请求的组成,以调用通过委托或者信任委托获取临时安全凭证接口说明如何调用API。该API通过切换已创建的IAM委托或者信任委托获取临时安全凭证,临时安全凭证是用户的访问令牌,承载身份与权限信息,用于调用其他API时进行请求签名

您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987

请求URI

请求URI由如下部分组成。

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。

  • URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。
  • Endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点处获取。例如STS服务在“华北-北京四”区域的Endpoint为“sts.cn-north-4.myhuaweicloud.com”
  • resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“通过委托或者信任委托获取临时安全凭证”API的resource-path为“/v5/agencies/assume”
  • query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。

例如您需要通过IAM在“华北-北京四”区域切换委托或者信任委托获取临时安全凭证,则需使用“华北-北京四”区域的Endpoint(sts.cn-north-4.myhuaweicloud.com),并在通过委托或者信任委托获取临时安全凭证的URI部分找到resource-path(/v5/agencies/assume),拼接起来如下所示。

https://sts.cn-north-4.myhuaweicloud.com/v5/agencies/assume
图1 URI示意图

为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。

请求方法

HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。

  • GET:请求服务器返回指定资源。
  • PUT:请求服务器更新指定资源。
  • POST:请求服务器新增资源或执行特殊操作。
  • DELETE:请求服务器删除指定资源,如删除对象等。
  • HEAD:请求服务器资源头部。
  • PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。

通过委托或者信任委托获取临时安全凭证的URI部分,您可以看到其请求方法为“POST”,则其请求为:

POST https://sts.cn-north-4.myhuaweicloud.com/v5/agencies/assume

请求消息头

附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。

如下公共消息头需要添加到请求中。

  • Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。
  • Authorization:请求签名信息,必选。用户可以使用永久AK/SK或者临时安全凭证按照AK/SK认证对请求进行签名。

    API使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。

    AK/SK认证的详细说明请参加AK/SK认证

  • X-Project-ID:子项目ID,可选,在多项目场景中使用。
  • X-Domain-ID:账号ID (等同于 AccountId)。

对于通过委托或者信任委托获取临时安全凭证接口,添加消息头后的请求如下所示。

POST https://sts.cn-north-4.myhuaweicloud.com/v5/agencies/assume
Content-Type: application/json
x-sdk-date: 20191115T033655Z 
Authorization: SDK-HMAC-SHA256 Access=QTWAOYTTINDUT2QVKYUC, SignedHeaders=content-type;host;x-sdk-date, Signature=7be6668032f70418fcc22abc52071e57aff61b84a1d2381bb430d6870f4f6ebe

请求消息体

请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容若请求体中包含中文,中文字符必须采用UTF-8编码

每个接口的消息体内容需要参考具体的API定义来填写,也不是每个请求都需要消息体,比如部分GET、DELETE操作就不需要消息体

对于通过委托或者信任委托获取临时安全凭证接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中agency_urn为目标委托的urn,agency_session_name为目标委托的会话名。

duration_seconds参数定义了安全凭证的时效,下面示例中获取的安全凭证仅在1小时内有效。您还可以进一步限制安全凭证权限范围,详细定义请参见通过委托或者信任委托获取临时安全凭证

POST https://sts.cn-north-4.myhuaweicloud.com/v5/agencies/assume
Content-Type: application/json
x-sdk-date: xxxxxxxxxxxxxxxxxx
Authorization: ********

{
  "duration_seconds": "3600"
  "agency_urn": "agency_urn",
  "agency_session_name": "agency_session_name",
}

到这里为止这个请求需要的内容就具备齐全了,您可以使用curlPostman或直接编写代码等方式发送请求调用API。对于通过委托或者信任委托获取临时安全凭证接口,返回的响应消息体中“credentials”就是需要获取的临时安全凭证。有了临时安全凭证之后,您就可以使用AK/SK认证调用其他API。

相关文档