检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。 调用方法 请参见如何调用API。 URI
ject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 envs Array of EnvInfo objects 本次返回的环境列表 表5 EnvInfo
ect-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 version_id 否 String API版本的编号 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 publish_id String 发布记录的ID api_id
查询实例指定的自定义入方向端口绑定的域名信息 功能介绍 查询实例指定的自定义入方向端口绑定的域名信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-p
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/envs/{env_id} 表1
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
String 指定需要精确匹配查找的参数名称,目前仅支持name、req_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明
头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 编号 name String 名称 remark String 描述 creator String APP的创建者 USER:用户自行创建 MARKET:云商店分配
设置APP的访问控制 功能介绍 设置凭据的访问控制。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选 参数类型
添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。 API的真实后端服务目前支持三种类型:传统的HTTP
缺省值:20 protocol 否 String 入方向端口的请求协议。 HTTP: 入方向端口为HTTP协议。 HTTPS: 入方向端口为HTTPS协议。 ingress_port 否 Integer 入方向端口的端口号,支持的端口范围为1024~49151。 最小值:1024 最大值:49151
查询包含指定标签的实例数量 功能介绍 查询包含指定标签的实例数量。 接口约束 使用策略授权用户时,需要包含apig:instance:getNumByTags的授权项才允许调用此接口。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apig
参数类型 描述 acl_id String 删除失败的ACL策略ID acl_name String 删除失败的ACL策略名称 error_code String 删除失败的错误码 error_msg String 删除失败的错误信息 状态码: 400 表7 响应Body参数 参数
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_quota_id 是 String 凭据配额编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
ken接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 authorizer_list Array of AuthorizerResp
本次查询返回的API历史版本列表 表5 ApiVersionResp 参数 参数类型 描述 version_id String API历史版本的ID version_no String API的版本号 api_id String API编号 env_id String 发布的环境编号
新增实例的自定义入方向端口 功能介绍 新增实例的自定义入方向端口,在同个实例中,一个端口仅能支持一种协议。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports