检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
新增实例的自定义入方向端口 功能介绍 新增实例的自定义入方向端口,在同个实例中,一个端口仅能支持一种协议。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports
ken接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 quotas Array of AppQuotaInfo
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选
ect-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 version_id 否 String API版本的编号 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 publish_id String 发布记录的ID api_id
创建APP Code 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes
实例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参数
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
本次查询返回的API历史版本列表 表5 ApiVersionResp 参数 参数类型 描述 version_id String API历史版本的ID version_no String API的版本号 api_id String API编号 env_id String 发布的环境编号
String 需要进行的操作。 online:发布 offline:下线 env_id 是 String 环境的编号,即:API需要发布到哪个环境 api_id 是 String API的编号,即:需要进行发布或下线的API的编号 remark 否 String 对发布动作的简述。字符长度不超过255
URE: 前端自定义认证的身份来源信息缺失或不合法错误 BACKEND_UNAVAILABLE: 后端不可用,网络不可达错误 BACKEND_TIMEOUT: 后端超时,与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED:
certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
查询包含指定标签的实例数量 功能介绍 查询包含指定标签的实例数量。 接口约束 使用策略授权用户时,需要包含apig:instance:getNumByTags的授权项才允许调用此接口。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apig
导入方式 导入方式包含以下2种: 生成新的分组:将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。 选择已有分组:将API定义导入到一个已有的分组,导入过程中不会删除分组中已有的API,只是将新增的API导入分组。 API分组 仅在
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
每种实例版本提供包年/包月、按需计费两种计费模式,以满足不同场景下的用户需求。 包年/包月:一种预付费模式,即先付费再使用,按照订单的购买周期进行结算。购买周期越长,享受的折扣越大。一般适用于设备需求量长期稳定的成熟业务。 按需计费:一种后付费模式,即先使用再付费,按照API网关
用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval 是 Integer 流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。
ect-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 配额名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头 最小长度:3 最大长度:255 call_limits 是 Integer 凭据配额的访问次数限制 最小长度:1