检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
type 是 String 认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。 in 是 String 仅支持header。 description 否 String 描述信息。 父主题: APIG的API设计文件扩展定义
请求消息样例: { "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "remark": "发布到生产环境" } 响应消息 表4 参数说明 名称 类型 说明 publish_id String 发布记录的ID api_id String API
表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps 请求消息 表2 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字,英文,数字,“_”,且只能以英文和汉字开头,3 ~ 64个字符。
表2 参数说明 名称 是否必选 类型 说明 id 是 String 流控策略的ID。
表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 app_code 是 String APP的名称 支持英文,+_!@#$%/=,且只能以英文和+、/开头,64-180个字符。
说明 type 是 String 策略条件类型,支持equal、enum、pattern。
表2 参数说明 名称 是否必选 类型 说明 id 是 String 流控策略编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 流控策略名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。
说明 total Integer 满足条件的API总数 size Integer 本次返回的API列表长度 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 group_id
group_id 是 String 分组的编号 domain_id 是 String 域名的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 证书名称。
页码,默认值:1 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的分组总数 size Integer 本次查询返回的分组个数 purchases 字典数据类型 本次查询返回的分组列表 表4 purchases参数说明 参数 类型
表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
表2 参数说明 名称 是否必选 类型 说明 id 是 String 环境变量的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 环境变量的编号 env_id String 环境编号 group_id String API分组编号 variable_name
删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。
表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
表2 参数说明 名称 是否必选 类型 说明 api_id 是 String API的编号 请求消息 表3 参数说明 名称 是否必选 类型 说明 scheme 是 String API的请求协议 HTTP HTTPS method 是 String API的请求方法 GET POST
表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表10
表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。