- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
- SDK参考
- 场景代码示例
-
常见问题
-
产品咨询类
- 云解析服务是否计费?
- 支持创建多少个域名/记录集/反向解析?
- 华为云DNS对用户提供域名服务的DNS服务器地址是什么?
- 华为云云解析服务提供的内网DNS地址是多少?
- 公网解析与内网解析有什么区别?
- 是否同时支持IPv4和IPv6解析?
- 是否支持显性/隐性URL转发功能?
- 是否支持动态域名解析?
- 是否支持泛解析?
- 什么是TTL值?
- 云解析服务最高支持几级域名?
- 域名解析的顺序是什么?
- DNS解析线路的优先级顺序是什么?
- SOA记录中的Email格式为什么变化了?
- 什么是CAA?
- MX优先级有什么意义?
- 云解析服务是否支持端口解析?
- 如何配置NSCD服务实现缓存加速并提高DNS可用性?
- 怎样提高自建DNS的响应时效?
- 如何使用Serving Stale提高自建DNS的解析成功率?
- 如何配置Nginx解析域名?
- 是否支持通过EDNS获取客户端真实IP地址实现精准调度?
- 域名解析不生效
- 网站无法访问
- 公网域名解析
- 内网域名解析
- 反向解析
- 域名转移
- 邮箱解析
-
产品咨询类
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
构造请求
本节介绍REST API请求的组成,并以调用IAM服务的管理员创建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不同,您可以从地区和终端节点中获取。例如IAM服务在“华北-北京四”(中国站)区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”(中国站)。
- resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“管理员创建IAM用户”接口的resource-path为“/v3.0/OS-USER/users”。
- query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。
例如您需要创建IAM用户,由于IAM为全局服务,则使用任一区域的Endpoint(比如“华北-北京四”区域的Endpoint:“iam.cn-north-4.myhuaweicloud.com”),并在管理员创建IAM用户的URI部分找到resource-path(/v3.0/OS-USER/users),拼接起来如下所示。
https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users
![](https://support.huaweicloud.com/api-dns/zh-cn_image_0000002021668340.png)
为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
HTTP请求方法(也称为操作或动词),它告诉服务正在请求什么类型的操作。
- GET:请求服务器返回指定资源。
- PUT:请求服务器更新指定资源。
- POST:请求服务器新增资源或执行特殊操作。
- DELETE:请求服务器删除指定资源,如删除对象等。
- HEAD:请求服务器资源头部。
- PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。
在管理员创建IAM用户的URI部分,您可以看到其请求方法为“POST”,则其请求为:
POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users
请求消息头
附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
如下公共消息头需要添加到请求中。
- Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。
- Authorization:签名认证信息,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参加AK/SK认证。
- X-Sdk-Date:请求发送的时间,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参加AK/SK认证。
- X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。
- X-Project-ID:子项目ID,可选,在多项目场景中使用。如果云服务资源创建在子项目中,AK/SK认证方式下,操作该资源的接口调用需要在请求消息头中携带X-Project-ID。
- X-Domain-ID:账号ID,可选。AK/SK认证方式下,全局服务的接口调用时,需在请求消息头中携带X-Domain-ID。
对于管理员创建IAM用户接口,使用AK/SK方式认证时,添加消息头后的请求如下所示。
POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码,并在Content-type中声明字符编码方式,例如:Content-Type: application/json; charset=utf-8。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。
- accountid为IAM用户所属的账号ID。
- username为要创建的IAM用户名。
- email为IAM用户的邮箱。
- **********为IAM用户的登录密码。
POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } }
到此为止,一个API请求所需要的内容已经准备完成,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。