华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识：create（创建），delete（删除） tags 是 Array of TmsKeyValue objects 标签列表。 一个实例默认最多支持创建20个标签。 数组长度：0 - 20 表4 TmsKeyValue 参数 是否必选 参数类型 描述 key 否 String 键。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : = + - @； _sys_开头属于系统标签，租户不能输入 最小长度：1 最大长度：128 value 否 String 值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @ 最小长度：0 最大长度：255

响应示例 状态码：401 Unauthorized { "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method" } 状态码：500 Internal Server Error { "error_code" : "APIC.9000" }

请求示例 批量添加实例的标签 { "action" : "create", "tags" : [ { "key" : "test-key", "value" : "test-value" } ] } 批量删除实例的标签 { "action" : "delete", "tags" : [ { "key" : "test-key1", "value" : "test-value" }, { "key" : "test-key2" } ] }

响应参数 状态码：204 No Content 状态码：400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码：400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3093", "error_msg" : "App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 id String 证书ID name String 证书名称 type String 证书类型 global：全局证书 instance：实例证书 instance_id String 实例编码 type为global时，缺省为common type为instance时，为实例编码 project_id String 租户项目编号 common_name String 域名 san Array of strings san扩展域名 not_after String 有效期到 signature_algorithm String 签名算法 create_time String 创建时间 update_time String 更新时间 is_has_trusted_root_ca Boolean 是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。 缺省值：false algorithm_type String 证书算法类型： RSA ECC SM2 version Integer 版本 organization Array of strings 公司、组织 organizational_unit Array of strings 部门 locality Array of strings 城市 state Array of strings 省份 country Array of strings 国家 not_before String 有效期从 serial_number String 序列号 issuer Array of strings 颁发者 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码：200 OK { "id" : "a27be832f2e9441c8127fe48e3b5ac67", "name" : "cert_demo", "common_name" : "apigtest.example.com", "san" : [ "apigtest.example.com", "*.san.com" ], "version" : 3, "organization" : [ "XX" ], "organizational_unit" : [ "IT" ], "locality" : [ "XX" ], "state" : [ "XX" ], "country" : [ "XX" ], "not_before" : "2019-06-01T00:00:00Z", "not_after" : "2031-08-16T06:36:13Z", "serial_number" : "13010", "issuer" : [ "XXSSL Inc" ], "signature_algorithm" : "SHA256-RSA", "create_time" : "2021-08-20T02:03:53Z", "update_time" : "2021-08-20T02:03:53Z", "algorithm_type" : "RSA" } 状态码：400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:domain_id. Please refer to the support documentation" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3020", "error_msg" : "The URL domain does not exist" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 修改一个SSL证书 { "name" : "cert_demo", "private_key" : "'-----BEGIN PRIVATE KEY-----THIS IS YOUR PRIVATE KEY-----END PRIVATE KEY-----\\n'", "cert_content" : "'-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----\\n'" }

响应示例 状态码：200 OK { "id" : "a27be832f2e9441c8127fe48e3b5ac67", "name" : "cert_demo", "common_name" : "apigtest.example.com", "san" : [ "apigtest.example.com", "*.san.com" ], "version" : 3, "organization" : [ "XX" ], "organizational_unit" : [ "IT" ], "locality" : [ "XX" ], "state" : [ "XX" ], "country" : [ "XX" ], "not_before" : "2019-06-01T00:00:00Z", "not_after" : "2031-08-16T06:36:13Z", "serial_number" : "13010", "issuer" : [ "XXSSL Inc" ], "signature_algorithm" : "SHA256-RSA", "create_time" : "2021-08-20T02:03:53Z", "update_time" : "2021-08-20T02:03:53Z", "algorithm_type" : "RSA" } 状态码：400 Bad Request { "error_code" : "APIG.3325", "error_msg" : "The dictionary name already exists" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3093", "error_msg" : "App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 id String 证书ID name String 证书名称 type String 证书类型 global：全局证书 instance：实例证书 instance_id String 实例编码 type为global时，缺省为common type为instance时，为实例编码 project_id String 租户项目编号 common_name String 域名 san Array of strings san扩展域名 not_after String 有效期到 signature_algorithm String 签名算法 create_time String 创建时间 update_time String 更新时间 is_has_trusted_root_ca Boolean 是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。 缺省值：false algorithm_type String 证书算法类型： RSA ECC SM2 version Integer 版本 organization Array of strings 公司、组织 organizational_unit Array of strings 部门 locality Array of strings 城市 state Array of strings 省份 country Array of strings 国家 not_before String 有效期从 serial_number String 序列号 issuer Array of strings 颁发者 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 证书名称。支持中文，英文字母，数字，下划线，且只能以英文或汉字开头，4~50个字符。 说明： 中文字符必须为UTF-8或者unicode编码。 cert_content 是 String 证书内容 private_key 是 String 证书私钥 type 否 String 证书可见范围 缺省值：global instance_id 否 String 所属实例ID，当type=instance时必填 trusted_root_ca 否 String 信任的根证书CA algorithm_type 否 String 证书算法类型： RSA ECC SM2 cert_content_sign 否 String 签名类型证书内容，仅algorithm_type=SM2时必填。 最大长度：8092 private_key_sign 否 String 签名类型私钥内容，仅algorithm_type=SM2时必填。 最大长度：8092

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 member_groups 否 Array of MemberGroupCreate objects 后端服务器组列表 表4 MemberGroupCreate 参数 是否必选 参数类型 描述 member_group_name 是 String VPC通道后端服务器组名称。支持汉字、英文、数字、下划线、中划线、点，且只能以英文和汉字开头，3-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 member_group_remark 否 String VPC通道后端服务器组描述。 最大长度：255 member_group_weight 否 Integer VPC通道后端服务器组权重值。 当前服务器组存在服务器且此权重值存在时，自动使用此权重值分配权重。 最小值：0 最大值：100 dict_code 否 String VPC通道后端服务器组的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 最小长度：3 最大长度：64 microservice_version 否 String VPC通道后端服务器组的版本，仅VPC通道类型为微服务时支持。 最大长度：64 microservice_port 否 Integer VPC通道后端服务器组的端口号，仅VPC通道类型为微服务时支持。端口号为0时后端服务器组下的所有地址沿用原来负载端口继承逻辑。 最小值：0 最大值：65535 microservice_labels 否 Array of MicroserviceLabel objects VPC通道后端服务器组的标签，仅VPC通道类型为微服务时支持。 reference_vpc_channel_id 否 String 引用的负载通道编号，仅VPC通道类型为引用类型（vpc_channel_type=reference）时支持。 最小长度：0 最大长度：64 表5 MicroserviceLabel 参数 是否必选 参数类型 描述 label_name 是 String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 label_value 是 String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63

响应示例 状态码：201 Created 示例 1 { "total" : 1, "size" : 1, "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_id" : "105c6902457144a4820dff8b1ad63331", "member_group_remark" : "", "member_group_weight" : 10, "create_time" : "2020-07-23T07:24:33Z", "update_time" : "2020-07-23T07:24:33Z", "microservice_version" : "", "microservice_port" : 0, "microservice_labels" : [ ] } ] } 示例 2 { "total" : 1, "size" : 1, "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_id" : "105c6902457144a4820dff8b1ad63331", "member_group_remark" : "", "member_group_weight" : 10, "create_time" : "2020-07-23T07:24:33Z", "update_time" : "2020-07-23T07:24:33Z", "microservice_version" : "v1", "microservice_port" : 80, "microservice_labels" : [ { "label_name" : "cluster_id", "label_value" : "c429700c-5dc4-482a-9c0e-99f6c0635113" } ] } ] } 状态码：400 Bad Request { "error_code" : "APIG.2001", "error_msg" : "The request parameters must be specified, parameter name:name" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3023", "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 创建服务器类型的VPC通道后端服务器组 { "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_weight" : 10 } ] } 创建微服务类型的VPC通道后端服务器组 { "member_groups" : [ { "member_group_name" : "vpc_member_group", "member_group_weight" : 10, "microservice_version" : "v1", "microservice_port" : 80, "microservice_labels" : [ { "label_name" : "cluster_id", "label_value" : "c429700c-5dc4-482a-9c0e-99f6c0635113" } ] } ] }

响应参数 状态码：201 表6 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 member_groups Array of MemberGroupInfo objects VPC通道后端服务器组列表 表7 MemberGroupInfo 参数 参数类型 描述 member_group_name String VPC通道后端服务器组名称。支持汉字、英文、数字、下划线、中划线、点，且只能以英文和汉字开头，3-64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 member_group_remark String VPC通道后端服务器组描述。 最大长度：255 member_group_weight Integer VPC通道后端服务器组权重值。 当前服务器组存在服务器且此权重值存在时，自动使用此权重值分配权重。 最小值：0 最大值：100 dict_code String VPC通道后端服务器组的字典编码 支持英文，数字，特殊字符（-_.） 暂不支持 最小长度：3 最大长度：64 microservice_version String VPC通道后端服务器组的版本，仅VPC通道类型为微服务时支持。 最大长度：64 microservice_port Integer VPC通道后端服务器组的端口号，仅VPC通道类型为微服务时支持。端口号为0时后端服务器组下的所有地址沿用原来负载端口继承逻辑。 最小值：0 最大值：65535 microservice_labels Array of MicroserviceLabel objects VPC通道后端服务器组的标签，仅VPC通道类型为微服务时支持。 reference_vpc_channel_id String 引用的负载通道编号，仅VPC通道类型为引用类型（vpc_channel_type=reference）时支持。 最小长度：0 最大长度：64 member_group_id String VPC通道后端服务器组编号 create_time String VPC通道后端服务器组创建时间 update_time String VPC通道后端服务器组更新时间 表8 MicroserviceLabel 参数 参数类型 描述 label_name String 标签名称。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 label_value String 标签值。 以字母或者数字开头和结尾，由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度：1 最大长度：63 状态码：400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号

实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性，可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持apig实例节点访问日志上报功能。 是 {"name":"lts","enable":true,"config": "{\"group_id\": ",\"topic_id\":\"\",\"log_group\":\"\",\"log_stream\":\"\"}"} group_id 日志组ID。 - - topic_id 日志流ID。 log_group 日志组名称。 log_stream 日志流名称。 gateway_responses 是否支持网关自定义响应。 否 - - - - - ratelimit 是否支持自定义流控值。 是 {"name":"ratelimit","enable":true,"config": "{\"api_limits\": 500}"} api_limits API全局默认流控值。注意：如果配置过小会导致业务持续被流控，请根据业务谨慎修改。 200 次/秒 1-1000000 次/秒 request_body_size 是否支持设置请求体大小上限。 是 {"name":"request_body_size","enable":true,"config": "104857600"} request_body_size 请求中允许携带的Body大小上限。 12 M 1-9536 M backend_timeout 是否支持配置后端API的最大超时时间。 是 {"name":"backend_timeout","enable":true,"config": "{"max_timeout": 500}"} max_timeout API网关到后端服务的超时时间上限。 60000 ms 1-600000 ms app_token 是否开启app_token认证方式。 是 {"name":"app_token","enable":true,"config": "{\"enable\": \"on\", \"app_token_expire_time\": 3600, \"app_token_uri\": \"/v1/apigw/oauth2/token\", \"refresh_token_expire_time\": 7200}"} enable 是否开启。 off on/off app_token_expire_time access token的有效时间。 3600s 1-72000s refresh_token_expire_time refresh token的有效时间。 7200s 1-72000s app_token_uri 获取token的uri。 /v1/apigw/oauth2/token - app_token_key token的加密key。 - - app_api_key 是否开启app_api_key认证方式。 是 {"name":"app_api_key","enable":true,"config": "on"} - - off on/off app_basic 是否开启app_basic认证方式。 是 {"name":"app_basic","enable":true,"config": "on"} - - off on/off app_secret 是否支持app_secret认证方式。 是 {"name":"app_secret","enable":true,"config": "on"} - - off on/off app_jwt 是否支持app_jwt认证方式。 是 {"name":"app_jwt","enable":true,"config": "{\"enable\": \"on\", \"auth_header\": \"Authorization\"}"} enable 是否开启app_jwt认证方式。 off on/off auth_header app_jwt认证头。 Authorization - public_key 是否支持public_key类型的后端签名。 是 {"name":"public_key","enable":true,"config": "{\"enable\": \"on\", \"public_key_uri_prefix\": \"/apigw/authadv/v2/public-key/\"}"} enable 是否开启public_key认证方式。 off on/off public_key_uri_prefix 获取public key的uri前缀。 /apigw/authadv/v2/public-key/ - backend_token_allow 是否支持普通租户透传token到后端。 是 {"name":"backend_token_allow","enable":true,"config": "{\"backend_token_allow_users\": [\"user_name\"]}"} backend_token_allow_users 透传token到后端普通租户白名单，匹配普通租户domain name正则表达式。 - - sign_basic 签名密钥是否支持basic类型。 否 - - - - - multi_auth API是否支持双重认证方式。 否 - - - - - backend_client_certificate 是否开启后端双向认证。 是 {"name":"backend_client_certificate","enable":true,"config": "{\"enable\": \"on\",\"ca\": \"\",\"content\": \"\",\"key\": \"\"}"} enable 是否开启。 off on/off ca 双向认证信任证书。 - - content 双向认证证书。 - - key 双向认证信任私钥。 - - ssl_ciphers 是否支持https加密套件。 是 {"name":"ssl_ciphers","enable":true,"config": "config": "{\"ssl_ciphers\": [\"ECDHE-ECDSA-AES256-GCM-SHA384\"]}"} ssl_ciphers 支持的加解密套件。ssl_ciphers数组中只允许出现默认值中的字符串，且数组不能为空。 - ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-RSA-AES128-GCM-SHA256,ECDHE-ECDSA-AES256-SHA384,ECDHE-RSA-AES256-SHA384,ECDHE-ECDSA-AES128-SHA256,ECDHE-RSA-AES128-SHA256 route 是否支持自定义路由。 否 - - - - - cors 是否支持API使用插件功能。 否 - - - - - real_ip_from_xff 是否开启使用X-Forwarded-For头中的ip作为ACL、流控的生效依据。 是 {"name": "real_ip_from_xff","enable": true,"config": {"enable": "on","xff_index": -1}} enable 是否开启。 off on/off xff_index X-Forwarded-For头中IP的排序序号；值可以取正数、负数、0；取0或正数时，获取X-Forwarded-For头中对应索引的IP；取负数时，按倒序方式从X-Forwarded-For头中获取IP。例如到达API网关的X-Forwarded-For头中依次有IP1，IP2，IP3 三个IP地址，xff_index取0时获取IP1，xff_index取1时获取IP2，xff_index取-1时获取IP3。 -1 int32有效值 app_route 是否支持ip访问。 是 {"name":"app_route","enable":true,"config": "on"} - - off on/off vpc_name_modifiable 是否支持修改负载通道名称。 是 {"name":"vpc_name_modifiable","enable":true,"config": "on"} - - on on/off default_group_host_trustlist DEFAULT分组是否支持配置非本实例IP访问。 是 {"name":"default_group_host_trustlist","enable": true,"config": "{\"enable\":\"on\",\"hosts\":[\"123.2.2.2\",\"202.2.2.2\"]}"} enable 是否开启。 - on/off hosts 非本实例IP列表。 - - throttle_strategy 是否启用流控模式。 是 {"name":"throttle_strategy","enable":true,"config": "{\"enable\": \"on\",\"strategy\": \"local\"}"} enable 是否开启。 off on/off strategy 流控模式。 - cluster/local custom_log 是否支持用户自定义API请求中的HEADER、QUERY、COOKIE参数值打印到日志。 是 {"name":"custom_log","enable":true,"config": "{\"custom_logs\":[{\"location\":\"header\",\"name\":\"a1234\"}]}"} custom_logs 自定义日志。 - 数量不超过10个 location 位置。 header/query/cookie name 名称。 - real_ip_header_getter 是否开启通过用户自定义的Header获取用户源IP地址。 是 {"name":"real_ip_header_getter","enable":true,"config": "{\"enable\": \"on\",\"header_getter\": \"header:testIP\"}"} enable 是否开启。 off on/off header_getter 获取用户源IP地址的自定义Header。 - - policy_cookie_param 是否开启策略后端条件支持cookie类型。 是 {"name":"policy_cookie_param","enable":true,"config": "on"} - - off on/off app_quota 是否支持客户端配额策略。 否 - - - - - app_acl 是否支持流控策略。 否 - - - - - set_resp_headers 是否支持响应header插件。 否 - - - - - vpc_backup 是否支持VPC通道的主备配置。 否 - - - - - sign_aes 签名密钥是否支持AES加密方式。 否 - - - - - kafka_log 是否支持增删改查kafka日志插件。 否 - - - - - backend_retry_count 是否支持API配置重试次数。 否 - - - - - policy_sys_param 策略后端条件来源是否支持系统参数。 否 - - - - - breaker 是否支持断路器。 否 - - - - - content_type_configurable 获取API列表的接口返回信息中是否存在API的请求参数类型信息（Content-Type）。 否 - - - - - rate_limit_plugin 是否支持流控插件。 否 - - - - - breakerv2 是否支持断路器，能够实现过载情况下服务能力降级。 否 - - - - - sm_cipher_type 加密本地敏感数据时，是否支持应用商密加密算法。 否 - - - - - rate_limit_algorithm 是否支持切换流控算法。 否 - - - - - gzip 是否对响应请求使用gzip压缩。 是 { "name" : "gzip", "config" : {\"comp_level\":6}, "enable" : true } comp_level gzip压缩级别或压缩水平。值为介于1到9之间的整数，表示压缩的程度，数字越大表示压缩得越好但耗费的时间也越多。 6 1-9 sse_strategy 是否支持sse传输策略开关。 是 { "name": "sse_strategy", "enable": true, "config": "on" } - - off on/off authorizer_context_support_num_bool 自定认证返回的context里键值对的值是否支持number类型和boolean类型。 否 - - - - - custom_auth_header APP认证和签名密钥策略是否支持认证头域自定义配置。 是 1：{ "name": "custom_auth_header", "enable": true, "config": "{\"app_auth_header\":\"app-header\", \"backend_sign_header\":\"back-header\"}" } app_auth_header 请求头中的APP认证的签名信息的头域可以由此处的配置项承载。 - 支持英文、数字、中划线、下划线，以英文开头，3-64个字符，可以为空，不能以x-apig、x-sdk开头，不区分大小写，不能是x-stage、authorization，不区分大小写 backend_sign_header 签名密钥策略（BASIC、AUTH和HMAC）传到后端的签名信息的头域可以由此处的配置项承载。 - request_custom_config 支持自定义配置客户端请求相关参数。 是 { "name": "request_custom_config", "enable": true, "config": "{\"http2\":\"on\",\"client_body_timeout\":10}" } http2 HTTP/2协议的开关。 on on/off client_body_timeout 客户端请求体超时时间。 8s 1-60s gateway_responses_support_header 分组自定义响应支持自定义响应头。 否 - - - - - api_uri_no_escape API中请求path的请求参数是否支持不转义。 是 {"name":"api_uri_no_escape","enable":true,"config":""} enable 是否开启。 false true/false ip_control 是否开启访问控制。 是 {"enable": true,"name":"ip_control","config":"{\"control_type\":\"white\",\"white_ip_list\":\"\",\"black_ip_list\":\"\"}"} control_type 控制类型。 black black/white white_ip_list 白名单IP列表。 - - black_ip_list 黑名单IP列表。 - - kafka_log_plugin_options 是否支持Kafka日志推送插件自定义消息长度。 是 {"name":"kafka_log_plugin_options","enable":true,"config": "{\\"request_body_size\\": 1000,\\"response_body_size\\": 1000}"} request_body_size 请求体消息的自定义长度。单位：字节。 1000 1000-4096 response_body_size 响应体消息的自定义长度。单位：字节。 1000 1000-4096 父主题： 附录

URI PUT /v2/{project_id}/apigw/instances/{instance_id}/acls 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 action 是 String 必须为delete

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 success_count Integer 删除成功的ACL策略数量 failure Array of AclBatchResultFailureResp objects 删除失败的ACL策略及错误信息 表6 AclBatchResultFailureResp 参数 参数类型 描述 acl_id String 删除失败的ACL策略ID acl_name String 删除失败的ACL策略名称 error_code String 删除失败的错误码 error_msg String 删除失败的错误信息 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码：200 OK { "failure" : [ { "acl_id" : "7eb619ecf2a24943b099833cd24a01ba", "acl_name" : "acl_demo", "error_code" : "APIG.3447", "error_msg" : "The access control policy has been bound to APIs" } ], "success_count" : 1 } 状态码：400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value: parameter action should be \\\"delete\\\"" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 app_quota_id String 凭据配额编号 name String 配额名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3-255字符 call_limits Integer 凭据配额的访问次数限制 time_unit String 限定时间单位：SECOND:秒、MINUTE:分、HOUR:时、DAY:天 time_interval Integer 配额的限定时间值 remark String 参数说明和描述 最大长度：255 reset_time String 首次配额重置时间点，不配置默认为首次调用时间计算 create_time String 创建时间 bound_app_num Integer 配额策略已绑定应用数量 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 app_quota_id 是 String 凭据配额编号

响应示例 状态码：200 OK { "app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3", "call_limits" : 1000, "create_time" : "2020-09-19T07:27:47Z", "name" : "ClientQuota_demo", "reset_time" : "2020-09-20 00:00:00 +0000 +0000", "time_interval" : 1, "time_unit" : "DAY" } 状态码：400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3093", "error_msg" : "App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应示例 状态码：200 OK { "instance_num" : 27, "nums_on_release" : 11, "nums_off_release" : 6 } 状态码：400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Bad Request { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 instance_num Integer API总个数 nums_on_release Integer 已发布到release环境的API个数 nums_off_release Integer 未发布到release环境的API个数 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码：200 OK { "datapoints" : [ { "average" : 5, "timestamp" : 1665304920000, "unit" : "Byte" } ] } 状态码：400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_id. Please refer to the support documentation" } 状态码：401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码：403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码：404 Not Found { "error_code" : "APIG.3002", "error_msg" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist" } 状态码：500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

URI GET /v2/{project_id}/apigw/instances/{instance_id}/metric-data 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 dim 是 String 指标维度 inbound_eip：入口公网带宽，仅ELB类型实例支持 outbound_eip：出口公网带宽 metric_name 是 String 指标名称 upstream_bandwidth：出网带宽 downstream_bandwidth：入网带宽 upstream_bandwidth_usage：出网带宽使用率 downstream_bandwidth_usage：入网带宽使用率 up_stream：出网流量 down_stream：入网流量 from 是 String 查询数据起始时间，UNIX时间戳，单位毫秒。 to 是 String 查询数据截止时间UNIX时间戳，单位毫秒。from必须小于to。 period 是 Integer 监控数据粒度。 1：实时数据 300：5分钟粒度 1200：20分钟粒度 3600：1小时粒度 14400：4小时粒度 86400：1天粒度 filter 是 String 数据聚合方式。 average：聚合周期内指标数据的平均值。 max：聚合周期内指标数据的最大值。 min：聚合周期内指标数据的最小值。 sum：聚合周期内指标数据的求和值。 variance：聚合周期内指标数据的方差。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 datapoints Array of MetricData objects 指标数据列表 表5 MetricData 参数 参数类型 描述 average Integer 聚合周期内指标数据的平均值，仅当请求参数filter字段值为average时支持。 max Integer 聚合周期内指标数据的最大值，仅当请求参数filter字段值为max时支持。 min Integer 聚合周期内指标数据的最小值，仅当请求参数filter字段值为min时支持。 sum Integer 聚合周期内指标数据的求和值，仅当请求参数filter字段值为sum时支持。 variance Integer 聚合周期内指标数据的方差，仅当请求参数filter字段值为variance时支持。 timestamp Long 指标采集时间，UNIX时间戳，单位毫秒。 unit String 指标单位。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码：204 No Content 状态码：400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 sign_bindings_id 是 String API与签名密钥的绑定关系编号