调用API-华为云

CLOUDPOND云服务-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），它告诉您服务正在请求什么类型的操作。表2 HTTP方法方法说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

CLOUDPOND云服务如何调用API

CLOUDPOND云服务-构造请求:请求URI

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

CLOUDPOND云服务如何调用API

CLOUDPOND云服务-构造请求:请求消息体（可选）

请求消息体（可选）该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 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": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

CLOUDPOND云服务如何调用API

CLOUDPOND云服务-构造请求:请求消息头

请求消息头附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。详细的公共请求消息头字段请参见表3。表3 公共请求消息头名称描述是否必选示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。否使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。是 application/json Content-Length 请求body长度，单位为Byte。否 3495 X-Auth-Token 用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。否使用Token认证时该字段必选。注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

CLOUDPOND云服务如何调用API

华为云WELINK-返回结果:响应消息体

响应消息体响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。对于统一认证获取access_token接口，返回如下消息体。 { "access_token": "eyJraWQiOiJjZjE0Y2EzZi1lZTM3LTRhYWItYWY5ZS1kMjJiYzY5NDZkZDIiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIxMjMwNDAwMDAxNyIsImF1ZCI6ImFpLXNoZW5nc2ktY2xpZW50LWlkIiwibmJmIjoxNjkyNzc0MTUyLCJzY29wZSI6WyJwcm9maWxlIl0sImlzcyI6Imh0dHA6XC9cLzEwLjI0Ny4xMzMuNTg6ODAwMyIsImV4cCI6MTY5Mjc3NTk1MiwiaWF0IjoxNjkyNzc0MTUyLCJhdXRob3JpdGllcyI6IlBFUk1JU1NJT05fQUxMIn0.fqWdl18V0tUNeR6QXdRJj8ZaQ5cG_JXx1ZYaMfJhOQfcIS_L1qYdOz44T88KbWvvF-gzbY0zAiNAYomglK6eGwfFmc38Gfkga-T9AtIqE_4yQlN-1nH IDT 2irn_CLhCPVH2ZpI-GtVUbWHstk-IlSsrznbVv9QLByS45JgBzcXtI8Nb0v2AehqPpDXxCLr0F_PUg58ldLKZtC6MFN_AcFfCWE9V_h6P8B9x3aUKJnOjAhx9Hmt52DbWeeZBTPq6VD1dqffORrP28d6nwac0bgLmfJUB9Y0S9otSoWFBryE-vY1TXtd1nYBfcKkGXlsWyepocfvE4aJdJikd95Rr9tI_kR50z7KqC9_nmtMt2v9UpN100W5lY9GRkhurwaMziKEe0v9mkjAROliiX5N5JuQQ4If3Nx_BGJL-OEy6tQiqdOE0dGxDz9KtWSVIp_UlY9eb8GCQszXZa9-jYJhPPpgixLA5ZEWh_KUHkctZ7877VMDLJrFI-D964XqNkXTUk", "refresh_token": "Y1DyiJFg6KaBi-q0xgiqNQM5QrhoGOI-lgTpihU5xl18eiuSP95kSHz_YBCB7pL_wlj9-6Cun97JLxvv9GfSTzMhxvdFGmsvb3EbphPu-zKqVMWrbmPbw5ghXiFPcuav", "scope": "profile", "token_type": "Bearer", "expires_in": 1800 } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "code": 61010202, "data": "invalid_grant", "message": "无效的code" } 其中，error_code表示错误码，error_msg表示错误描述信息。

华为云WELINK 如何调用API

应用管理与运维平台 SERVICESTAGE-构造请求:请求消息头

请求消息头附加请求头字段，如指定的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=****************

应用管理与运维平台 SERVICESTAGE 如何调用API

应用管理与运维平台 SERVICESTAGE-构造请求:请求消息体

请求消息体请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则Content-type中需声明字符编码方式为UTF-8。例如，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" } } 到这里为止这个请求需要的内容就齐全了，您可以使用curl、postman或直接编写代码等方式发送请求调用API。

应用管理与运维平台 SERVICESTAGE 如何调用API

应用管理与运维平台 SERVICESTAGE-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），表示服务正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

应用管理与运维平台 SERVICESTAGE 如何调用API

应用管理与运维平台 SERVICESTAGE-构造请求:请求URI

请求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用户”API的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 图1 URI示意图为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

应用管理与运维平台 SERVICESTAGE 如何调用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 身份中心-构造请求:请求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 身份中心-构造请求:请求方法

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

IAM 身份中心如何调用API

数据治理中心 DATAARTS STUDIO-调用API方式简介

调用API方式简介创建API时，有三种认证方式可选，不同认证方式的API支持的调用方式也有所不同，详见表1。表1 API认证与调用方式说明认证方式安全级别授权与认证机制支持的调用方式调用方法示例使用说明（推荐）APP认证高通过APP应用将API授权给应用后，使用应用的密钥对（AppKey和AppSecret）进行安全认证。（推荐）SDK调用：支持Java、Go、Python、JavaScript、C#、PHP、C++、C、Android等多种语言。 API工具调用：需要通过JavaScript SDK包中的demo.html手动生成签名后，再使用API工具调用。（推荐）通过SDK调用APP认证方式的API 通过API工具调用APP认证方式的API 推荐使用APP认证+SDK调用方式，帮助您简单、快速地通过数据API获取到开放数据。 IAM认证中通过IAM应用或白名单将API授权给账号后，借助从IAM服务获取的用户Token进行安全认证。 API工具调用：需要调用IAM服务的获取用户Token接口获取Token ，再使用API工具调用。通过API工具调用IAM认证方式的API API工具调用场景可使用IAM认证方式。无认证低无需授权，所有用户均可访问。 API工具调用：直接调用，无需认证信息。浏览器调用：当API入参位置在Query和Path时，支持浏览器调用。如果入参位置在Header或Body，由于无法传参因此不支持浏览器调用。通过API工具调用无认证方式的API 通过浏览器调用无认证方式的API 无认证方式建议仅在测试接口时使用，不推荐正式使用。若调用方为不可信任用户，则存在数据库安全风险（如数据泄露、数据库高并发访问导致宕机、SQL注入等风险）。父主题：通过不同方式调用API

数据治理中心 DATAARTS STUDIO 通过不同方式调用API

数据复制服务 DRS-认证鉴权:Token认证

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

数据复制服务 DRS 如何调用API

AI开发平台MODELARTS-返回结果:响应消息体

响应消息体响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息，具体请参见错误码。

AI开发平台MODELARTS 如何调用API

云服务器内容精选

调用API

7*24

备案

专业服务

退订

建议反馈

售前咨询热线