如何调用API-华为云

IAM 身份中心-构造请求:请求URI

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URL 参数说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP，不同服务在不同区域，Endpoint不同，可以从地区和终端节点处获取。例如 IAM 身份中心服务的Endpoint为identitycenter.myhuaweicloud.com。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“列出实例”API的resource-path为“/v1/instances”。 query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。例如您需要获取IAM身份中心的实例信息，则需使用IAM身份中心的Endpoint（identitycenter.myhuaweicloud.com），并在列出实例的URI部分找到resource-path（/v1/instances），拼接起来如下所示。 1 https://identitycenter.myhuaweicloud.com/v1/instances 为查看方便，每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

IAM 身份中心如何调用API

IAM 身份中心-构造请求:请求消息头

请求消息头添加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”。 Authorization：请求消息中可带的签名信息，必选，AK/SK认证的详细说明请参见：AK/SK认证。 X-Sdk-Date：请求发送的时间，必选，例如：20221107T020014Z。 Host：表明主机地址，必选，如identitycenter.myhuaweicloud.com。 API支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见：AK/SK认证。对于列出实例接口，请求如下所示。 GET https://identitycenter.myhuaweicloud.com/v1/instances content-type: application/json X-Sdk-Date: 20230330T021902Z host: identitycenter.myhuaweicloud.com Authorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx

IAM 身份中心如何调用API

IAM 身份中心-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。在列出实例的URI部分，您可以看到其请求方法为“GET”，则其请求为： GET https://identitycenter.myhuaweicloud.com/v1/instances

IAM 身份中心如何调用API

资源编排服务 RFS-认证鉴权:AK/SK认证

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

资源编排服务 RFS 如何调用API

资源编排服务 RFS-认证鉴权:Token认证

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

资源编排服务 RFS 如何调用API

ASTRO轻应用 ASTROZERO-构造请求:请求URI

请求URI 请求URI由如下部分组成： {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。表1 URI中的参数说明参数说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的AstroZero服务器域名或IP。例如，AstroZero开发环境服务器在“华北-北京四”区域的Endpoint为“appcube.cn-north-4.huaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/baas/auth/v1.0/oauth2/token”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。多个查询参数之间使用“&”隔开。例如，使用OAuth 2.0协议的客户端鉴权模式，获取用户access_token，“/baas/auth/v1.0/oauth2/token”为资源路径，假设AstroZero服务开发态域名为“appcube.cn-north-4.huaweicloud.com”，URI拼接起来如下所示。 https://appcube.cn-north-4.huaweicloud.com/baas/auth/v1.0/oauth2/token

ASTRO轻应用 ASTROZERO 如何调用API

ASTRO轻应用 ASTROZERO-构造请求:请求消息头

请求消息头附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。详细的公共请求消息头字段请参见表3。表3 公共请求消息头消息头名称描述是否必选 Content-Type HTTP协议中设定的一个参数，用于标识返回的内容用什么格式去解析。配置为“application/json”。表示浏览器将返回内容解析为json对象。配置为“application/x-www-form-urlencoded”，表示urlencode格式。是 tenant-id 账号的标识，不能重复，用于定义哪个账号接收请求。否 access-token access-token是调用AstroZero接口API要用到的访问令牌，在调用API的时候将access-token加到请求消息头，从而通过身份认证，获得操作API的权限。当AstroZero的用户和业务用户通过账号密码登录AstroZero后，后台会生成一个访问令牌，在响应消息中携带，并存在浏览器中。下次再调用请求后，会带上这个访问令牌，表示这个用户已经被鉴权过。当第三方系统要访问AstroZero的业务接口时，需要提前使用OAuth协议进行接入认证，获取客户端鉴权ID（Client ID）和客户端鉴权密钥（Client Secret），再使用客户端鉴权ID和客户端鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”获取access_token，从而获取AstroZero业务接口的访问令牌。否使用access-token认证时该字段必选。对于使用OAuth 2.0的客户端鉴权模式，获取用户access_token接口，由于不需要access-token认证，所以只添加“Content-Type”为“application/x-www-form-urlencoded”即可，添加消息头后的请求如下所示。 POST https://appcube.cn-north-4.huaweicloud.com/baas/auth/v1.0/oauth2/token Content-Type: application/x-www-form-urlencoded

ASTRO轻应用 ASTROZERO 如何调用API

ASTRO轻应用 ASTROZERO-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。表2 HTTP方法方法说明 GET 请求服务器返回指定资源，如获取对象列表。 PUT 请求服务器更新指定资源，如按记录ID更新数据。 POST 请求服务器新增资源或执行特殊操作，如新增对象数据。 DELETE 请求服务器删除指定资源，如按记录ID列表删除对象数据。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。在使用OAuth 2.0的客户端鉴权模式，获取用户access_token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://appcube.cn-north-4.huaweicloud.com/baas/auth/v1.0/oauth2/token

ASTRO轻应用 ASTROZERO 如何调用API

ASTRO轻应用 ASTROZERO-构造请求:发起请求

发起请求到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于使用OAuth 2.0的客户端鉴权模式，获取的用户access_token接口。返回的响应消息中，“access_token”就是需要获取的用户access_token。有了access_token之后，就可以使用access_token调用AstroZero的其他API。

ASTRO轻应用 ASTROZERO 如何调用API

测试计划 CODEARTS TESTPLAN-构造请求:请求消息头

请求消息头附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求头“Content-Type”，请求鉴权信息等。如下公共消息头需要添加到请求中：名称描述是否必选备注 Content-Type 消息体的类型（格式）是默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token 用户Token 否用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID 子项目ID 否在多项目场景中使用 X-Domain-ID 账号ID - - 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参考AK/SK认证。对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

测试计划 CODEARTS TESTPLAN 如何调用API

测试计划 CODEARTS TESTPLAN-构造请求:请求消息体

请求消息体请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxx为project的ID，获取方法请参见获取项目ID。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { id": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

测试计划 CODEARTS TESTPLAN 如何调用API

测试计划 CODEARTS TESTPLAN-构造请求:请求URI

请求URI 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。请求URI由四部分构成：{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}。各参数含义如下：参数说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如，IAM服务在华北-北京一区域的Endpoint为iam.cn-north-1.myhuaweicloud.com。 resource-path 资源路径，即API访问路径，从具体API的URI模块获取。例如，获取用户Token接口的resource-path为/v3/auth/tokens。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个？，形式为参数名=参数取值。例如，limit=10表示查询不超过10条数据。例如：如果需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示： https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

测试计划 CODEARTS TESTPLAN 如何调用API

测试计划 CODEARTS TESTPLAN-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。详情如下：请求方法说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。在获取用户Token的URI部分，若请求方法为POST，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

测试计划 CODEARTS TESTPLAN 如何调用API

云应用引擎 CAE-认证鉴权:AK/SK认证

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。 AK/SK既可以使用永久访问密钥中的AK/SK，也可以使用临时访问密钥中的AK/SK，但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段，字段值为临时访问密钥的security_token。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

云应用引擎 CAE 如何调用API

云应用引擎 CAE-认证鉴权:Token认证

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

云应用引擎 CAE 如何调用API

云服务器内容精选

如何调用API

7*24

备案

专业服务

退订

建议反馈

售前咨询热线