计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MgC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
数智融合计算服务 DataArtsFabric
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
华为云Astro轻应用
华为云Astro大屏应用
开源治理服务 CodeArts Governance
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

构造请求

更新时间:2025-03-19 GMT+08:00

本节介绍REST API请求的组成,并以使用OAuth 2.0协议的客户端鉴权模式获取用户access_token为例说明如何调用API,该API获取access_token,access_token可以用于调用其他API时鉴权。

请求URI

请求URI由如下部分组成:

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

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

表1 URI中的参数说明

参数

说明

URI-scheme

表示用于传输请求的协议,当前所有API均采用HTTPS协议。

Endpoint

指定承载REST服务端点的华为云Astro轻应用服务器域名或IP。

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”为资源路径,假设华为云Astro轻应用服务开发态域名为“appcube.cn-north-4.huaweicloud.com”,URI拼接起来如下所示。

https://appcube.cn-north-4.huaweicloud.com/baas/auth/v1.0/oauth2/token

请求方法

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

请求消息头

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

详细的公共请求消息头字段请参见表3
表3 公共请求消息头

消息头名称

描述

是否必选

Content-Type

HTTP协议中设定的一个参数,用于标识返回的内容用什么格式去解析。

  • 配置为“application/json”,表示浏览器将返回内容解析为json对象。
  • 配置为“application/x-www-form-urlencoded”,表示urlencode格式。

tenant-id

账号的标识,不能重复,用于定义哪个账号接收请求。

access-token

access-token是调用华为云Astro轻应用接口API要用到的访问令牌,在调用API的时候将access-token加到请求消息头,从而通过身份认证,获得操作API的权限。

当华为云Astro轻应用的用户和业务用户通过账号密码登录华为云Astro轻应用后,后台会生成一个访问令牌,在响应消息中携带,并存在浏览器中。下次再调用请求后,会带上这个访问令牌,表示这个用户已经被鉴权过。当第三方系统要访问华为云Astro轻应用的业务接口时,需要提前使用OAuth协议进行接入认证,获取客户端鉴权ID(Client ID)和客户端鉴权密钥(Client Secret),再使用客户端鉴权ID和客户端鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”获取access_token,从而获取华为云Astro轻应用业务接口的访问令牌。

使用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

请求消息体(可选)

请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。

对于使用OAuth 2.0的客户端鉴权模式,获取的用户access_token接口,您可以从表4看到所需的请求参数及参数说明。

表4 请求参数说明

参数名称

类型

必选(M)/可选(O)

参数位置

参数含义

grant_type

String

M

Body

授权模式,OAuth2.0中的grant_type字段的取值。

例如:client_credentials(即客户端模式)

client_id

String

M

Body

客户端ID,获取方法如下:

  1. 在华为云Astro轻应用服务控制台,单击进入首页,进入应用开发页面。
  2. 在页面左上方单击,选择环境管理 > 环境配置,进入环境配置。
  3. 选择“集成连接 > OAuth”,单击“新建”。
  4. 输入OAuth名称,设置授权类型为“客户端模式”,选择一个用户(当鉴权成功后,将获得到和此用户相同的权限。注意不要具有选择匿名用户权限“Anonymous_User_Profile”的用户,因为该权限不能访问API)。
  5. 在OAuth管理列表页,单击具体OAuth所在行,下载密钥文件到本地,从中获取客户端鉴权ID“client_id”取值。

client_secret

String

M

Body

客户端密钥。

参考client_id,获取客户端鉴权密钥“client_secret”取值。

redirect_url

String

O

Body

重定向URL。

locale

String

O

Body

语言。

例如:en_US

将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写。

POST https://appcube.cn-north-4.huaweicloud.com/baas/auth/v1.0/oauth2/token 
Content-Type: application/x-www-form-urlencoded 
  
grant_type=client_credentials&client_id=********&client_secret=********

发起请求

到这里为止这个请求需要的内容就具备齐全了,您可以使用curlPostman或直接编写代码等方式发送请求调用API。

对于使用OAuth 2.0的客户端鉴权模式,获取的用户access_token接口。返回的响应消息中,“access_token”就是需要获取的用户access_token。有了access_token之后,就可以使用access_token调用华为云Astro轻应用的其他API。

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容