# 构造请求 本节介绍REST API请求的组成，并以调用IAM服务的[管理员创建IAM用户](https://support.huaweicloud.com/api-iam/iam_08_0015.html)接口为例说明如何调用API。该API用于管理员创建IAM用户。 您还可以通过这个视频教程了解如何构造请求调用API： 。 #### 请求URI 请求URI由如下部分组成： **{URI-scheme}://{Endpoint}/{resource-path}?{query-string}** 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1URI中的参数说明 | **参数** | **描述** | |:---|:---| | URI-scheme | 表示用于传输请求的协议，当前所有API均采用**HTTPS**协议。 | | Endpoint | 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同。 终端节点（Endpoint）即调用API的**请求地址** ，不同服务不同区域的终端节点不同。本服务的Endpoint您可以从[终端节点Endpoint](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0004.html)获取。 例如DataArts Studio数据集成组件在"华北-北京四"区域的Endpoint为"cdm.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用户](https://support.huaweicloud.com/api-iam/iam_08_0015.html)接口的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 ``` https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users ``` 图1URI示意图 ![](https://support.huaweicloud.com/api-dataartsstudio/zh-cn_image_0000002023846164.png) ![](https://support.huaweicloud.com/api-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png) 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。 #### 请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2HTTP方法 | **方法** | **说明** | |:---|:---| | GET | 请求服务器返回指定资源。 | | PUT | 请求服务器更新指定资源。 | | POST | 请求服务器新增资源或执行特殊操作。 | | DELETE | 请求服务器删除指定资源，如删除对象等。 | | HEAD | 请求服务器资源头部。 | | PATCH | 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 | 在IAM的[管理员创建IAM用户](https://support.huaweicloud.com/api-iam/iam_08_0015.html)接口的URI部分，您可以看到其请求方法为"POST"，则其请求为： ``` POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users ``` #### 请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头"Content-Type"，请求鉴权信息等。 详细的公共请求消息头字段请参见[表3]。 表3公共请求消息头 | **名称** | **描述** | **是否必选** | **示例** | |:---|:---|:---|:---| | Content-Type | 消息体的类型（格式），默认取值为"application/json"。 如果请求消息体中含有中文字符，则还需要通过charset=utf8指定中文字符集。 | 是 | application/json;charset=utf8 | | Content-Length | 请求body长度，单位为Byte。 | 否 | 3495 | | X-Language | 请求语言。 | 否 | en_us | | X-Auth-Token | 用户Token。用户Token是调用[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口的响应值，因此调用[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | 使用Token认证时该字段必选。 | 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ | | Authorization | 签名认证信息。 当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。 | 使用AK/SK认证时必选。 | - | | X-Sdk-Date | 请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')，取值为当前系统的GMT时间。 当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。 | 使用AK/SK认证时必选。 | 20150907T101459Z | | Host | 请求的服务器信息，从服务API的URL中获取。值为hostname\[:port\]。端口缺省时使用默认的端口，https的默认端口为443。 | 使用AK/SK认证时必选。 | code.test.com or code.test.com:443 | | X-Project-Id | 子项目ID。请参考[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)章节获取项目ID。 | 调用在子项目中的服务接口，并使用AK/SK认证时必选。 | e9993fc787d94b6c886cbaa340f9c0f4 | | X-Domain-ID | 账号ID。请参考[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)章节获取账号ID。 | 调用全局服务接口，并使用AK/SK认证时必选。 | 0a2f5e28af00f3850f31c00f31e884e0 | | workspace | 工作空间id，获取方式请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | - 调用批量数据迁移或实时数据接入API时无需配置。 - 调用数据开发API时，有多个DataArts Studio实例时必选。 只有一个DataArts实例时可选。不填写则默认查询default工作空间数据，如需查询其他工作空间需要带上该消息头。 - 调用其他组件API时必选，否则会调用失败。 | d1cd7861478748a6925bc02f47c69279 | | X-Dlm-Type | 数据服务版本类型，用于请求数据服务时，指定共享版/专享版 | 调用数据服务接口时必选 | 共享版: SHARED 专享版: EXCLUSIVE | ![](https://support.huaweicloud.com/api-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png) API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见[认证鉴权](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0010.html)的"AK/SK认证"。 对于[管理员创建IAM用户](https://support.huaweicloud.com/api-iam/iam_08_0015.html)接口，使用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=**************** ``` #### 请求消息体 请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于[管理员创建IAM用户](https://support.huaweicloud.com/api-iam/iam_08_0015.html)接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写： - **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](https://curl.haxx.se/)、[Postman](https://www.getpostman.com/)或直接编写代码等方式发送请求调用API。