检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
借助API网关,可以简单、快速、低成本、低风险地实现内部系统集成和业务能力开放。API网关帮助您变现服务能力的同时,降低企业研发投入,让您专注于企业核心业务,提升运营效率。
最新动态(html) 本文介绍了Huawei Cloud EulerOS产品新特性和对应的文档动态,新特性将在各个区域(Region)陆续发布,欢迎体验。
None 操作指导 API网关 APIG 介绍开放API的操作流程 04:34 开放API API网关 APIG 介绍如何创建流控策略 02:11 设置流量控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) API网关 APIG 介绍如何调用
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 无 Bad Request url clientId clientSecret错误。 检查调用参数或者联系运营开发人员定位。
响应消息头 该部分可选。 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于Access Token接口,不返回响应消息头。 响应消息体 该部分可选。
API概览 OrgID服务提供了多个API接口,包含获取Access Token、获取用户信息等的接口,如表1所示。 表1 接口说明 API 说明 获取AccessToken 获取Access Token,Access Token可用于调用获取用户信息API。 获取用户信息 获取用户信息
Content-type对应,传递除请求消息头之外的内容。
API网关 APIG SCP不直接进行授权,只划定权限边界。将SCP绑定到组织单元或者成员账号时,并没有直接对组织单元或成员账号授予操作权限,而是规定了成员账号或组织单元包含的成员账号的授权范围。
调用说明 OrgID提供了REST(Representational State Transfer)风格API,支持通过HTTPS请求调用。 调用方法请参见如何调用API。 父主题: 使用前必读
基于OAuth的应用认证集成 获取AccessToken 获取用户信息 父主题: API
如何调用API 构造请求 返回结果
API 基于OAuth的应用认证集成 基于CAS的应用认证集成
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同。 使用OrgID服务API无需关注终端节点,需要使用OrgID的公网访问域名,OrgID的公网访问域名为“orgid.huaweiapaas.cn”。 父主题: 使用前必读
API网关 APIG APIG专享版实例配置安全认证类型 APIG专享版实例配置访问日志 APIG专享版实例域名均关联SSL证书 父主题: 系统内置预设策略
固定值“Bearer”,消息头传入token时前缀填入方式。 expires_in Long 访问令牌的有效期,以秒为单位。 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。
获取用户信息 功能介绍 获取用户信息。 URI GET /orgid/openapi/v1/oauth2/userinfo 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-OrgID-Authorization 是 String 用户访问凭证,即Bearer
状态码 状态码如表1所示。 表1 状态码 状态码 编码 说明 200 OK 正常响应。 400 Bad Request 参数错误响应。 401 Unauthorized 权限错误响应。 500 Internal Server Error 系统错误响应。 父主题: 附录
验证票据 功能介绍 CAS3.0方式应用验证票据,并获取用户属性信息。 URI GET /orgid/openapi/v1/cas/p3/serviceValidate 表1 Query参数 参数 是否必选 参数类型 描述 service 是 String 登录时携带的回调地址。
修订记录 发布日期 修订记录 2024-02-29 第一次正式发布。
基于CAS的应用认证集成 验证票据 父主题: API
使用前必读 概述 调用说明 终端节点
概述 组织成员账号OrgID是面向企业提供组织管理、企业成员账号管理以及SaaS应用授权管理能力的云服务。OrgID通过将Huawei ID扩展到组织内部应用领域,实现对组织部门、用户、账号、应用、认证源的统一管理。 在调用OrgID的API之前,请确保已经充分了解OrgID相关概念
附录 状态码 错误码
登录失败 输入用户名、密码后提示异常 登录时提示用户状态异常 从OrgID跳转到Huawei ID失败 从控制台跳转到OrgID界面显示网络未连接