检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
variable_name String 变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值替换。 说明: 中文字符必须为UTF-8或者unicode编码。 id String
ken的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 variables Array of EnvVariableInfo objects 本次返回的环境变量列表
是否必选 参数类型 描述 name 是 String API分组的名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 最小长度:3
查询编排规则绑定的API 功能介绍 查询指定插件下绑定的API信息 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instan
修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
ect-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 member_group_name 是 String VPC通道后端服务器组名称。支持汉字、英文、数字、下划线、中划线、点,且只能以英文和汉字开头,3-64字符。 说明: 中文字符必须为UTF-8或者unicode编码。
响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 signs Array of SignatureWithBindNum objects 本次查询到的签名密钥列表 表5 SignatureWithBindNum 参数
s/{domain_id}/certificate URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 name
修改ACL策略 功能介绍 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}
上述命令中,部分参数请参见以下说明进行修改,具体请参考《统一身份认证服务API参考》的获取用户Token接口: {iam_endpoint}请参见地区和终端节点获取。 {user_name}和{password}分别替换为连接IAM服务器的用户名和密码。 {project_id}为项目ID。在管理控制台,
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw
响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 证书名称。支持中文,英文字母,数字,下划线,且只能以英文或汉字开头,4~50个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content
String 需要进行的操作。 online:发布 offline:下线 env_id 是 String 环境的编号,即:API需要发布到哪个环境 api_id 是 String API的编号,即:需要进行发布或下线的API的编号 remark 否 String 对发布动作的简述。字符长度不超过255
certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
类型 说明 name 是 String 签名密钥的名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8
修改ACL策略 功能介绍 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls/{id}
ype来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com”之类的网络域名。 调用方法 请参见如何调用API。 URI POST /v2/{pro
VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“-”、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 type 是 Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型
String 分组的编号 domain_id 是 String 域名的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 证书名称。 长度为4 ~ 50位的字符串,字符串由中文、英文字母、数字、"_"组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。