检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对象模型 本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型
导入API到已有分组 功能介绍 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI PUT /v1.0/apigw/openapi?group_id={0}&mode={1}
切换API版本 功能介绍 API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 环境上存在已发布的API时,该环境不能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{proj
查询API概况 功能介绍 查询租户名下的API概况:已发布到RELEASE环境的API个数,未发布到RELEASE环境的API个数。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/r
专享版API(V1)的接口,只有上海二,广州,北京四,北京一,墨西哥和圣保罗局点支持注册,且仅用于存量用户使用。 请新用户在使用API时参考专享版API(V2)接口文档。 父主题: 专享版API(V1)(待下线)
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型
查看VPC通道列表 功能介绍 查看VPC通道列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/vpc-channels[?page_size, page_no, id
查看VPC通道详情 功能介绍 查看指定的VPC通道详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/vpc-channels/{id}
批量删除ACL策略 功能介绍 批量删除指定的多个ACL策略。 删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{proj
cript、C#、PHP、C++、C、Android等多种语言的SDK包。 您可以通过下载SDK包来调用API,具体操作请参考《API网关开发指南》。 父主题: 其他
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
验证API服务的功能是否正常可用。 发布API 把API发布到环境中,API只有在发布到环境后,才支持被调用。 调用API 企业或开发者如何获取并调用他人在API网关开放的API,减少开发时间与成本。 图3 调用API基本流程 获取API 获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及认证方式等信息。
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型
发布的环境名 run_env_id String 发布的环境id publish_id String 发布记录的编号 tag String 服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API
此外,APIG为所有客户提供相同的信息,以平等地保护所有客户。APIG不会向个别客户提供事先通知。 最后,APIG不会针对产品中的漏洞开发或发布可利用的入侵代码(或“验证性代码”)。 父主题: 漏洞公告
查询API列表 功能介绍 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/