响应消息体（可选） 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于创建API分组接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "id": "abcdef...", "name": "APIGroup_test", "remark": "api group remark", ...... } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The token is missing.", "error_code": "APIG.1000" } 其中，error_code表示错误码，error_msg表示错误描述信息。

实例支持的APIG特性 专享版实例支持的APIG特性。 若当前实例中无相关特性，可提交工单申请升级实例解决。 特性名称 特性描述 特性是否可配置 特性配置示例 特性配置参数 参数描述 参数默认值 参数范围 lts 是否支持shubao访问日志上报功能。 是 {"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 父主题： 附录

调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为IAM的终端节点，可以从地区与终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "xx-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 204 APIG.0000 Successful 请求成功 无 400 APIC.7211 Parameter value does not match the rules 参数与规则不匹配 修改参数与规则匹配 400 APIC.7230 The maintenance time window must be 4 hours. 运维时间必须等于4小时 修改运维起始时间和结束时间的间隔为4小时 400 APIC.7235 The maintenance time window must start or end with 2, 6, 10, 14, 18, or 22. 运维的起始或结束时间必须以 2,6,10,14,18,22开头 修改运维的起始或结束时间以 2,6,10,14,18,22开头 400 APIC.7238 An AZ must be specified. 可用区参数不能为空 创建实例时填写可用区参数 400 APIC.7239 Invalid IP address. ip地址格式不正确 使用正确的ip地址格式 400 APIC.7241 An enterprise project ID must be specified if you are an enterprise user. 企业用户必须填写企业项目编号 填写企业项目编号 400 APIC.7242 Load balancing is not supported by this edition. 该规格不支持负载均衡 调整实例规格 400 APIC.7243 Scale-up is not supported by this edition. 该规格不支持扩容 调整实例规格 400 APIC.7244 The bandwidth cannot be updated. 不支持更新带宽 不允许操作 400 APIC.7312 The AZ does not support IPv6. 不存在支持IPv6功能的可用区 更换其他支持IPv6功能的可用区 400 APIC.7313 The bandwidth for IPv6 cannot be less than 6 MB. IPv6对应的带宽大小不能小于6M 增加传入的带宽大小 400 APIC.7500 The gateway name already exists. 实例名称已存在 请使用其他实例名称 400 APIC.7503 Parameters az and azList cannot be used at the same time. az和azList参数只能存在一个 去掉az或azList参数 400 APIC.7505 The gateway ID already exists. 实例id已存在 请更换实例id 400 APIC.9206 Failed to create the gateway. 创建实例失败 根据不同的原因处理，如果资源不足，则扩充资源，如果网络异常则检查对应服务的网络，恢复网络连通性。 400 APIC.9208 Failed to disable public outbound access. 关闭出公网功能失败 请联系技术工程师排查日志 400 APIC.9210 create cloud nat eip failed 开启出公网功能失败 请联系技术工程师查看后台日志 400 APIC.9211 update bandwidth size failed 开启出公网功能或更新出公网带宽失败 请联系技术支持工程师协助解决 400 APIC.9215 Failed to scale up the gateway. 扩容实例失败 请联系技术工程师查看后台日志 400 APIC.9216 Failed to enable public inbound access. 开启公网入口功能失败 请联系技术工程师查看后台日志 400 APIC.9217 Failed to accept VPC peering connection or create route 接受对等连接和创建路由失败 请联系技术工程师查看后台日志 400 APIC.9218 Create instance failed due to insufficient quota. 因配额不够创建实例失败 修改配额后重试 400 APIC.9219 Create instance failed due to insufficient resources. 因资源不够创建实例失败 资源扩容后重试 400 APIC.9222 Lock gateway operation failed. 对实例操作进行加锁失败 请联系技术人员处理 400 APIG.1119 No permissions to perform this operation. 细粒度授权失败，无权限执行此操作 获取对应细粒度权限后使用 400 APIG.1120 No permissions to create ELB channels. 没有权限创建私网ELB通道 所操作的ELB通道应在自己账号下，子账号应获取授权后访问 400 APIG.1201 The resources belong to different tenants. 操作的资源不属于同一租户 操作的对象应该属于同一个租户 400 APIG.2000 Parameter error. 请求参数错误 根据接口返回的具体原因修改请求参数 400 APIG.2001 The request parameters must be specified. 请求参数为空 填写请求参数 400 APIG.2002 The parameter value is too small. 参数值小于最小值 修改请求参数 400 APIG.2003 The parameter value is too large. 参数值大于最大值 修改请求参数 400 APIG.2004 The parameter value is outside the allowable range. 参数值不在可选范围内 修改请求参数 400 APIG.2005 The parameter is too short. 参数长度太短 修改请求参数 400 APIG.2006 The parameter is too long. 参数长度太长 修改请求参数 400 APIG.2007 Invalid length. 参数长度非法 修改请求参数 400 APIG.2008 Only letters are allowed. 参数只能是字母 修改请求参数 400 APIG.2009 Only digits are allowed. 参数只能是数字 修改请求参数 400 APIG.2010 Only letters and digits are allowed. 参数只能是字母或数字 修改请求参数 400 APIG.2011 Invalid parameter value. 参数规则不匹配 修改请求参数 400 APIG.2012 Invalid parameter value. 参数匹配到不期望匹配的规则 修改请求参数 400 APIG.2013 Only letters, digits, hyphens (-), and underscores (_) are allowed. 参数只能是字母、数字、下划线或中划线 修改请求参数 400 APIG.2014 Invalid email address. 无效的邮件地址 修改请求参数 400 APIG.2015 Invalid IP address. 无效的IP地址 修改请求参数 400 APIG.2016 The characters are not encoded using Base 64. 不是base 64编码的字符 修改请求参数为正确的base 64编码字符串 400 APIG.2017 Invalid mobile number. 无效的手机号码 修改请求参数 400 APIG.2018 Invalid telephone number. 无效的固话号码 修改请求参数 400 APIG.2019 Invalid telephone or mobile number. 无效的电话号码 修改请求参数 400 APIG.2020 Invalid postal code. 无效的邮政编码 修改请求参数 400 APIG.2021 The URL domain is not included in the IP address whitelist. 域名不在允许的白名单内 修改请求参数 400 APIG.2022 The URL domain is included in the IP address blacklist. 域名处于禁止的黑名单内 修改请求参数 400 APIG.2023 URL domain CNAME resolution failed. 域名cname失败 先注册域名的cname解析记录 400 APIG.2024 Invalid URL domain. 域名非法 使用正确的域名 400 APIG.2025 Invalid port number. 无效的端口号 使用正确的端口号 400 APIG.2026 The request path parameters are not defined. 请求的路径参数未在请求路径中定义 将请求路径包含的参数添加到请求参数中 400 APIG.2027 The backend path parameters are not defined. 后端的路径参数未在后端路径中定义 将后端请求路径包含的参数添加到后端参数中 400 APIG.2028 The request parameters mapped to the backend parameters are not defined. 后端参数映射的请求参数未定义 后端参数中的参数来源，改为正确的请求参数 400 APIG.2029 The default certificate already exists. 默认证书已存在 请联系技术支持工程师协助解决 400 APIG.2030 Bad request for debugging the API. 调试API请求消息不合法 使用正确的API调试参数 400 APIG.2034 The domain name has not been filed. File it first. 域名未备案，请进入备案系统进行备案 先进行备案 400 APIG.2035 The ICP Filing System is busy. Please try again later. 备案系统繁忙，请稍后重试 请联系技术支持工程师协助解决 400 APIG.2036 Only APIs that use custom authentication can have authorizer parameters. 只有使用了自定义认证的API可以有自定义认证参数 删除多余的参数 400 APIG.2041 Invalid microservice. 微服务无效 Invalid microservice. 修改请求参数service_id为有效的微服务ID 400 APIG.2042 Invalid engine. 微服务引擎无效 修改请求参数engine_id为有效的微服务引擎ID 400 APIG.2044 Invalid title of info Info.title不合法 Info.title字段书写必须符合文档规范 400 APIG.2045 Parse Servers error. The Servers must meet the documents Servers字段解析错误。Servers字段书写必须符合文档规范。 Servers字段书写必须符合文档规范。 400 APIG.2101 The certificate and private key do not match. 证书与私钥不匹配 使用匹配的证书与私钥 400 APIG.2102 The certificate has expired. 证书过期 使用没有过期的证书 400 APIG.2103 The certificate domain name and the custom domain name do not match. 证书内域名与自定义域名不匹配 证书内的域名应与自定义域名相同 400 APIG.2104 The certificate chain is not matched. 证书链不匹配 包含了多个证书的证书链，需要将服务器证书放在第一个，后面依次放证书链证书 400 APIG.2105 Encrypted private keys are not supported. 不支持加密的私钥 使用没有加密的私钥 400 APIG.2106 Invalid certificate or private key. 无效的证书或私钥 使用正确的证书和私钥 400 APIG.2108 Microservice unavailable. 微服务不可用 修改请求参数service_id为可用的微服务ID 400 APIG.2109 Invalid certificate. SAN missing. 无效的证书，证书缺乏SAN 无效的证书，证书缺乏SAN，请重新生成带有SAN的证书 400 APIG.3148 Invalid certificate. Add one that expires before January 19, 2038 03:14:07 UTC. 证书到期日期不能超过 2038 年 1 月 19 日 03:14:07 UTC 之后的时间。 请添加一个在 2038 年 1 月 19 日 03:14:07 UTC 之前到期的证书。 400 APIG.3201 The API group name already exists. 指定的API分组名称已存在 使用其他名称 400 APIG.3202 The API name already exists. 指定的API名称已存在 使用其他名称 400 APIG.3203 The app name already exists. 指定的应用名称已存在 使用其他名称 400 APIG.3204 The request throttling policy name already exists. 指定的流控策略名称已存在 使用其他名称 400 APIG.3205 The environment name already exists. 指定的环境名称已存在 使用其他名称 400 APIG.3206 The access control policy name already exists. 指定的ACL策略名称已存在 使用其他名称 400 APIG.3207 The signature key name already exists. 指定的签名密钥名称已存在 使用其他名称 400 APIG.3208 The VPC channel name already exists. VPC通道名称已存在 使用其他名称 400 APIG.3209 The parameter name already exists. 参数名称已存在 使用其他名称 400 APIG.3210 The backend policy name already exists. 策略后端名称已存在 使用其他名称 400 APIG.3211 The authorizer name already exists. 指定的自定义认证名称已存在 使用其他名称 400 APIG.3212 The identity source name already exists. 指定的自定义认证身份来源已存在 使用其他名称 400 APIG.3213 The tag name already exists. 指定的标签名称已存在 使用其他名称 400 APIG.3216 The response name already exists. 指定的网关响应名称已存在 使用其他名称 400 APIG.3301 The API already exists. API已存在 修改API的方法和url，避免与其他API冲突 400 APIG.3302 The excluded configuration already exists. 特殊配置已存在 使用其他名称 400 APIG.3303 The environment variable already exists. 环境变量已存在 使用其他名称 400 APIG.3304 The purchasing order already exists. 订单已存在 请联系技术支持工程师协助解决 400 APIG.3305 The URL domain name already exists. 域名已存在 请联系技术支持工程师协助解决 400 APIG.3306 The IP address already exists. IP地址已存在 请联系技术支持工程师协助解决 400 APIG.3308 The excluded request throttling configuration already exists. 特殊流控策略已经存在 请联系技术支持工程师协助解决 400 APIG.3309 The operation has already been performed. 操作已经执行 请联系技术支持工程师协助解决 400 APIG.3310 The AppKey already exists. app key已存在 使用其他APP key 400 APIG.3316 The API authorization record already exists. API授权关系已经存在 使用其他API或APP授权 400 APIG.3330 VPC already bound to a microservice. VPC已经绑定了微服务 修改请求参数vpc_channel_id为未绑定微服务的 400 APIG.3331 The orchestration rule name already exists. 参数编排规则的名称已经存在 请修改参数编排的名称，使其与现有的参数编排规则的名称不重复 400 APIG.3600 JSON or YAML format error. Json或Yaml格式错误 请确认导入文件是否为yaml或者json，且格式正确 注：导入EXCEL文件也是这个报错 400 APIG.3601 The Swagger file version must be 2.0. swagger版本不是2.0 swagger版本必须为2.0 400 APIG.3602 Syntax error in the Swagger file. swagger语法错误 检查swagger语法错误 400 APIG.3603 The Swagger file content is too long. swagger内容超过限制 缩小swagger大小 400 APIG.3608 The API Designer does not support API modification. 不能在api设计器中修改api 请联系技术支持工程师协助解决 400 APIG.3609 The input file is empty. 输入文件为空 使用非空文件 400 APIG.3710 The VPC channel is being used by another third_auth plugin 指定的负载通道被第三方认证插件使用，不能删除 先解除第三方插件与负载通道的绑定，再删除负载通道 400 APIG.3715 A domain name can only be bound with CA certificates of the same algorithm type. 一个域名不能绑定不同算法类型的ca证书 请解绑域名原有的ca证书后再绑定 401 APIC.7100 Token missing. Log in again or try again later. 未识别到用户认证信息，请重新登录或稍后重试 携带token访问 401 APIC.7101 Token expired. Try again later. 认证信息过期，请稍后重试 重新获取token访问 401 APIC.7102 Incorrect token or token resolution failure 认证信息无法识别 请联系技术工程师检查是否token加解密配置异常 401 APIC.7103 Token contains no project information. 认证信息不包含project信息 获取token时携带project信息 401 APIC.7105 Token contains no user information. 认证信息不包含用户信息 获取token时使用用户信息 401 APIC.7107 Token contains no role information. 认证信息不包含角色信息 获取token时使用角色信息 401 APIG.1000 Token missing. Log in again or try again later. 未识别到用户认证信息，请重新登录或稍后重试 携带token访问 401 APIG.1001 Session expired. Please try again later. 会话过期，请稍后重试 重新获取token访问 401 APIG.1002 Incorrect token or token resolution failed. 认证信息无法识别 使用正确的token访问 401 APIG.1003 Token contains no project information. 认证不包含project信息 使用包含project信息的token访问 401 APIG.1005 No permissions to request this method 租户操作受限，请前往账号中心核实 使用包含所需权限的token访问 401 APIG.1007 Token contains no domain information. 认证不包含Domain信息 请联系技术支持工程师协助解决 401 APIG.1008 Invalid domain. 无法识别用户Domain信息 请联系技术支持工程师协助解决 401 APIG.1009 Token contains no user information. 认证不包含用户信息 使用包含用户信息的token访问 401 APIG.1010 PDP server connection failed. 连接细粒度授权服务器失败 请联系技术支持工程师协助解决 401 APIG.1011 You can request resources only after you complete real-name authentication. 您的账号未实名认证，暂时无法进行其他操作 实名认证后使用 401 APIG.1012 Your account balance is insufficient. Top up your account. 您的账户余额不足，请前往费用中心解决 充值后使用 401 APIG.1013 Your account has been frozen. Some functions become unavailable. To unfreeze your account, contact customer service. 您的账户已被冻结，部分功能会受到影响，请联系技术支持解除 解除账号受限后使用 403 APIC.7106 Operation restricted. Check at My Account. 租户操作受限，请前往账号中心核实 使用包含所需权限的token访问 403 APIC.7108 Access denied because your account is frozen. 账号冻结，没有权限访问 解除账号冻结状态后访问 403 APIC.7109 Access denied because your account is suspended. 账号受限，没有权限访问 解除账号受限状态后访问 403 APIC.7110 Your account only has read permissions and can only send GET requests. 只读账户，没有权限发送除GET之外的任何请求 联系账号管理员配置管理员或细粒度权限 403 APIC.7111 The requested resource does not belong to your account. 访问的资源不属于该账号 使用正确的token访问 403 APIC.7118 User domain does not match. User profile的domain不匹配 请检查domain信息是否正确 403 APIC.7130 No permissions to access gateways in other projects. 没有权限操作其他项目下的实例 使用正确的项目编号 403 APIC.7134 No permissions to access this enterprise project. 没有权限操作该企业项目 使用用户有权限操作的企业项目 403 APIC.7300 You do not have permission to perform action {x} on resource {x}. 没有权限对资源执行指定操作 请检查权限是否配置正确 403 APIC.7400 Maximum number of gateways reached. 实例个数超过最大配额 请联系技术工程师扩大实例配额 403 APIC.7402 The number of tags exceeds the maximum allowed limit. 标签个数达到限额 请删除无用的标签 403 APIG.1020 Insufficient permissions. 当前用户权限不足 授予该用户读写权限 403 APIG.1101 No permissions to perform operations on this API group. 没有权限操作该API分组 所操作的分组应在自己账号下，子账号应获取授权后访问 403 APIG.1102 No permissions to perform operations on this API. 没有权限操作该API 所操作的API应在自己账号下，子账号应获取授权后访问 403 APIG.1103 No permissions to perform operations on this environment. 没有权限操作该环境 所操作的环境应在自己账号下，子账号应获取授权后访问 403 APIG.1104 No permissions to perform operations on this app. 没有权限操作该应用 所操作的应用应在自己账号下，子账号应获取授权后访问 403 APIG.1105 No permissions to perform operations on this request throttling policy. 没有权限操作该流控策略 所操作的流控策略应在自己账号下，子账号应获取授权后访问 403 APIG.1106 No permissions to perform operations on this access control policy. 没有权限操作该ACL策略 所操作的ACL策略应在自己账号下，子账号应获取授权后访问 403 APIG.1107 No permissions to perform operations on this configuration. 没有权限操作该配置信息 请联系技术支持工程师协助解决 403 APIG.1108 No permissions to perform operations on this excluded configuration. 没有权限操作该特殊配置信息 请联系技术支持工程师协助解决 403 APIG.1109 No permissions to perform operations on this app authorization record. 没有权限操作该APP授权信息 所操作的APP授权应在自己账号下，子账号应获取授权后访问 403 APIG.1110 No permissions to perform operations on this environment variable. 没有权限操作该环境变量 所操作的环境变量应在自己账号下，子账号应获取授权后访问 403 APIG.1111 No permissions to perform operations on this subscription record. 没有权限操作该订购信息 所操作的订购关系应在自己账号下，子账号应获取授权后访问 403 APIG.1112 No permissions to perform operations on this signature key. 没有权限操作该签名密钥 所操作的签名密钥应在自己账号下，子账号应获取授权后访问 403 APIG.1113 No permissions to perform operations on this VPC channel. 没有权限操作该VPC通道 所操作的复制通道应在自己账号下，子账号应获取授权后访问 403 APIG.1115 No permissions to perform operations on this certificate. 没有权限操作该证书 所操作的证书应在自己账号下，子账号应获取授权后访问 403 APIG.1116 No permissions to perform operations on this on-sale API. 没有权限操作该上架中的API 所操作的API应在自己账号下，子账号应获取授权后访问 403 APIG.1136 No permissions to perform operations on this instance. 没有权限操作实例 请联系技术支持工程师协助解决 403 APIG.1137 No permissions to perform operations on this authorizer. 没有权限操作该自定义认证 所操作的自定义认证应在自己账号下，子账号应获取授权后访问 403 APIG.1140 No permissions to perform operations on this feature. 没有权限操作该特性 所操作的特性应在自己账号下，子账号应获取授权后访问 403 APIG.1200 No permissions to perform operations on this API Swagger file. 没有权限创建操作该swagger文档 所操作的API文档应在自己账号下，子账号应获取授权后访问 403 APIG.1301 No permissions to perform operations on this domain 没有权限操作此域名 所操作的域名应在自己账号下 403 APIG.3100 The number of resources exceeds the maximum allowed limit. 请求的资源数量超过限额 请联系技术支持工程师增大配额 403 APIG.3101 The number of API groups exceeds the maximum allowed limit. API分组数量超过限额 请联系技术支持工程师增大配额 403 APIG.3102 The number of APIs exceeds the maximum allowed limit. API数量超过限额 请联系技术支持工程师增大配额 403 APIG.3103 The number of apps exceeds the maximum allowed limit. 应用数量超过限额 请联系技术支持工程师增大配额 403 APIG.3104 The number of environments exceeds the maximum allowed limit. 环境数量超过限额 请联系技术支持工程师增大配额 403 APIG.3105 The number of signature keys exceeds the maximum allowed limit. 签名密钥数量超过限额 请联系技术支持工程师增大配额 403 APIG.3106 The number of variables exceeds the maximum allowed limit. 变量个数超过限额 请联系技术支持工程师增大配额 403 APIG.3107 The number of request throttling policies exceeds the maximum allowed limit. 流控策略个数超过限额 请联系技术支持工程师增大配额 403 APIG.3108 The number of domain names exceeds the maximum allowed limit. 分组自定义域名个数超过限额 请联系技术支持工程师增大配额 403 APIG.3109 The number of VPC channels exceeds the maximum allowed limit. VPC通道数量超过限额 请联系技术支持工程师增大配额 403 APIG.3110 The number of cloud servers in the VPC channel exceeds the maximum allowed limit. VPC通道中的云主机数量超过限额 请联系技术支持工程师增大配额 403 APIG.3111 The number of parameters in req_params exceeds the maximum allowed limit. API参数个数超过限额 请联系技术支持工程师增大配额 403 APIG.3112 The number of access control policies exceeds the maximum allowed limit. ACL策略个数超过限额 请联系技术支持工程师增大配额 403 APIG.3113 The number of API backend policies exceeds the maximum allowed limit. API的策略后端个数超过限额 请联系技术支持工程师增大配额 403 APIG.3114 The number of policy conditions exceeds the maximum allowed limit. 策略后端的策略条件个数超过限额 请联系技术支持工程师增大配额 403 APIG.3116 The number of authorizers exceeds the maximum allowed limit. 自定义认证个数超过限额 请联系技术支持工程师增大配额 403 APIG.3117 The number of identity sources exceeds the maximum allowed limit. 自定义认证身份来源个数超过限额 请联系技术支持工程师增大配额 403 APIG.3125 The number of APIs in the API group exceeds the maximum allowed limit. 分组内的API数量达到上限 请联系技术支持工程师增大配额 403 APIG.3127 The number of APIs has reached the upper limit. A maximum of xxx APIs can be imported at a time. 导入API数量超过限制，每次最多导入数量为：xxx 减少导入的api数量 403 APIG.3131 The number of AppCodes exceeds the maximum allowed limit. APP code数量超过限额 请联系技术支持工程师增大配额 403 APIG.3132 The number of Swagger APIs in the API group exceeds the maximum allowed limit. 分组下API swagger数量超过限额 请联系技术支持工程师增大配额 403 APIG.3133 The number of API tags exceeds the maximum allowed limit. API tag数量超过限额 请联系技术支持工程师增大配额 403 APIG.3136 The number of responses exceeds the maximum allowed limit. 网关响应数量超过限额 请联系技术支持工程师增大配额 403 APIG.3150 The number of orchestration rules exceeds the maximum. 实例参数编排规则的数量超过了实例所允许的最大值 请联系技术工程师扩大实例参数编排规则的配额 403 APIG.3151 The number of orchestration rules bound to the API exceeds the maximum. API绑定参数编排规则的数量超过了API所允许绑定的最大值 请联系技术支持工程师扩大API允许绑定参数编排规则的配额 403 APIG.3411 The APIs belong to different tenants. 指定的API不属于同一个租户，无法授权 不允许操作 403 APIG.3412 The API provider has been frozen. 该API提供者已经被冻结 请联系技术支持工程师协助解决 403 APIG.3414 The VPC channel is already being used by another API. 指定的VPC通道已经被API占用 删除负载通道绑定的API后再删除负载通道 403 APIG.3415 The API group cannot be deleted because it contains APIs. 指定的API分组下存在API 删除分组下的API后再删除分组 403 APIG.3416 The API cannot be deleted because it has been published. 指定的API已经发布 将API下线后再删除API 403 APIG.3418 The environment contains published APIs. 指定的环境下存在已发布的API 不允许操作 403 APIG.3420 The API group is no longer available on the marketplace. 指定的API分组已经退市 确认API分组是否上架 403 APIG.3447 The access control policy cannot be deleted because it has been bound to APIs. 指定的ACL策略绑定了API，无法删除 删除访问控制策略绑定的API后再删除访问控制策略 403 APIG.3451 The request throttling policy cannot be deleted because it has been bound to APIs. 指定的流控策略绑定了API，无法删除 删除流控策略绑定的API后再删除访问流控策略 403 APIG.3471 The operation cannot be performed on this type of VPC channel. 不能对该类型的VPC通道执行此操作 不允许操作 403 APIG.3472 The load balancer is already being used by another VPC channel. 后端实例已经被其它通道使用 解绑其他通道与后端实例的绑定关系 403 APIG.3473 The load balancer has already been bound to another endpoint service. 后端实例已经绑定了其它endpoint service 不允许操作 403 APIG.3474 The API group ID in the URL does not match the API group to which the URL domain has been bound. url中的分组id和url中的域名绑定的分组id不匹配 URL中的分组与域名绑定的分组修改为一致 404 APIC.7301 Instance spec not found 实例规格不存在 使用存在的实例规格 404 APIC.7302 Instance not found 实例不存在 检查实例是否存在，使用正确的实例ID 404 APIC.7307 The security group does not exist in the VPC. 安全组在VPC不存在 使用存在的安全组 404 APIC.7310 The region does not have any AZs. 该region中不存在可用区 使用其他region 404 APIC.7311 The NAT EIP does not exist in the VPC. vpc服务不存在该nat eip 使用vpc服务存在的nat eip 404 APIC.7314 The VPC Endpoint of the gateway does not exist. 实例对应的vpcep不存在 请联系技术支持工程师检查vpcep 404 APIG.3001 The API group does not exist 指定的API分组不存在 检查分组是否存在 404 APIG.3002 The API does not exist. 指定的API不存在 检查API是否存在 404 APIG.3003 The environment does not exist. 指定的环境不存在 检查环境是否存在 404 APIG.3004 The app does not exist. 指定的应用不存在 检查应用是否存在 404 APIG.3005 The request throttling policy does not exist. 指定的流控策略不存在 检查流控策略是否存在 404 APIG.3006 The access control policy does not exist. 指定的ACL策略不存在 检查ACL策略是否存在 404 APIG.3007 The configuration does not exist. 指定的配置不存在 检查配置是否存在 404 APIG.3008 The excluded configuration does not exist. 指定的特殊配置不存在 检查特殊配置是否存在 404 APIG.3009 The app authorization record does not exist. 指定的APP授权信息不存在 检查APP授权是否存在 404 APIG.3010 The access control policy binding record does not exist. 指定的ACL策略绑定记录不存在 检查ACL策略绑定记录是否存在 404 APIG.3011 The environment variable does not exist. 指定的环境变量不存在 检查环境变量是否存在 404 APIG.3012 The request throttling policy binding record does not exist. 指定的流控策略绑定记录不存在 检查流控策略绑定记录是否存在 404 APIG.3013 The excluded request throttling configuration does not exist. 指定的流控策略特殊配置不存在 检查流控策略特殊配置是否存在 404 APIG.3014 The pre-subscription record does not exist. 指定的订购信息不存在 检查订购信息是否存在 404 APIG.3015 The API publication record does not exist. 指定的API发布记录不存在 检查API发布记录是否存在 404 APIG.3016 The API group listing information does not exist. 指定的API分组上架信息不存在 检查API分组是否上架 404 APIG.3017 The signature key does not exist. 指定的签名密钥不存在 检查签名密钥是否存在 404 APIG.3018 The signature key binding record does not exist. 指定的签名密钥绑定记录不存在 检查签名密钥绑定记录是否存在 404 APIG.3019 The function URN does not exist. 指定的函数URN不存在 检查函数URN是否存在 404 APIG.3020 The URL domain does not exist. 指定的域名不存在 检查分组域名是否存在 404 APIG.3021 The SSL certificate does not exist. 指定的证书不存在 检查SSL证书是否存在 404 APIG.3022 The API version does not exist. 指定的API历史版本不存在 检查API版本是否存在 404 APIG.3023 The VPC channel does not exist. 指定的VPC通道不存在 检查负载通道是否存在 404 APIG.3024 The cloud server does not exist. 指定的云主机不存在 检查负载通道中是否存在该实例 404 APIG.3025 The certificate does not exist. 指定的证书不存在 检查证书是否存在 404 APIG.3030 The instance does not exist. 实例不存在 检查实例是否存在 404 APIG.3081 The authorizer does not exist. 自定义认证不存在 检查自定义认证是否存在 404 APIG.3082 The AppCode does not exist. APP code不存在 检查APP code是否存在 404 APIG.3087 The feature configuration does not exist. 实例特性配置不存在 检查特性是否存在 404 APIG.3090 The API Swagger file does not exist. Api swagger文档不存在 检查swagger文档是否存在 404 APIG.3092 The ECS does not exist. 弹性云服务器不存在 弹性云服务器被删除或者传入的ID错误 404 APIG.3094 Instance task does not exist. 实例异步任务不存在 实例异步任务被删除或者传入的ID错误 404 APIG.3095 The orchestrations does not exist 不存在该参数编排 请检查是否存在请求参数中所传的orchestration_id所对应的参数编排规则 404 APIG.3097 The binding record of this SSL certificate and domain name does not exist. 指定SSL证书和域名的绑定记录不存在 检查SSL证书和域名的绑定记录是否存在 409 APIC.7701 Instance status conflict. 实例状态冲突 等待实例升级完成后再操作 409 APIC.7707 Scaling up to the same specifications is not allowed. 不允许扩容到同一规格 扩容到其他规格 409 APIC.7709 Public network access is enabled for the gateway. 已开启实例公网出口 关闭实例公网出口后再操作 409 APIC.7710 ELB is available only when the instance is in the Available state. 当实例不是运行状态时，无法操作ELB。 联系技术工程师修复实例状态为运行后操作 409 APIC.7711 Public inbound access is enabled for the instance 已开启实例公网入口 请关闭实例公网入口后再操作 409 APIC.7712 The gateway operation has already been locked. 实例操作已经被锁 请处理待支付订单 409 APIG.1149 No permission for this instance task. 没有权限操作此实例异步任务 使用正确项目下的租户token访问 409 APIG.3491 The default response cannot be deleted. 默认网关响应不可被删除 不允许操作 409 APIG.3492 The default response name cannot be modified. 默认网关响应名称不可修改 不允许操作 409 APIG.3707 Only published APIs can be bound with plug-ins. 未发布的API不允许绑定插件 将API发布后再绑定到插件 409 APIG.3708 The key usage of the certificate does not match 证书使用类型不匹配 使用匹配的类型 409 APIG.3709 The signature algorithm of the certificate does not match 证书的算法类型与实际不匹配 更换证书算法类型 409 APIG.3711 A configuration parameter can be modified only once per minute. 实例配置参数修改间隔小于1分钟 请一分钟后再操作 409 APIG.3712 User domain does not match. User profile的domain不匹配 请检查domain信息是否正确 409 APIG.3716 The orchestration rule is currently in use by another API. 该编排正在被另一个API使用 请先解除编排规则和api的绑定 412 APIG.3458 The feature is not supported by the current instance. 当前实例不支持该特性 请联系技术支持工程师协助解决 412 APIG.3713 orchestration_mapped_param cannot be modified. orchestration_mapped_param里面的信息不能被修改 不修改orchestration_mapped_param里面的信息 412 APIG.3714 The backend request protocol does not support SM cryptographic algorithms. 后端请求协议不支持开启SM系列商密通道 请修改后端请求协议为HTTPS 500 APIC.7253 Internal configuration error. 内部配置错误 检查内部配置 500 APIC.9000 Failed to request internal service 访问内部服务异常 请联系技术工程师查看后台日志 500 APIC.9005 Order creation failed. 创建订单失败 请联系技术工程师排查后台与CBC相关的日志 500 APIC.9007 Failed to access VPCEP 访问VPCEP服务失败 请联系技术工程师排查VPCEP服务相关日志 500 APIC.9100 Failed to access the database. 操作数据库异常 请联系技术工程师排查后台数据库相关日志 500 APIC.9200 Failed to query AZ information. 查询可用区信息失败 请联系技术工程师查看后台日志 500 APIC.9204 Failed to bind the EIP. 绑定EIP失败 请联系技术工程师查看后台日志 500 APIC.9209 Failed to access EPS. 访问EPS服务异常 请联系技术工程师排查EPS服务相关后台日志 500 APIC.9999 System error. Contact technical support. 系统错误，请联系技术支持工程师 请联系技术支持工程师查看管理面后台日志定位具体错误 500 APIG.1029 PDP5 cannot be connected. PDP5服务连接失败 请检查PDP5服务连接是否正常 500 APIG.3500 Failed to synchronize data to etcd. 同步路由至ETCD异常 请联系技术支持工程师协助解决 500 APIG.9002 Invalid function URN. 函数URN校验失败 使用正确的函数URN 500 APIG.9003 Statistics Center request failed. 请求统计中心失败 请联系技术支持工程师协助解决 500 APIG.9004 IAM request failed. 请求IAM认证鉴权失败 请联系技术支持工程师协助解决 500 APIG.9005 VPC request failed. 请求VPC服务失败 请联系技术支持工程师协助解决 500 APIG.9006 DNS request failed. 请求dns服务失败 请联系技术支持工程师协助解决 500 APIG.9007 ELB request failed. 请求ELB服务失败 请联系技术支持工程师协助解决 500 APIG.9008 Too many requests. Try again later. 请求过于频繁，请稍后重试 稍后重试 500 APIG.9013 Synchronize CCMS data failed 同步CCMS数据失败 请联系技术支持工程师协助解决 500 APIG.9999 Internal Server Error 系统错误，请联系技术支持工程师 请联系技术支持工程师协助解决 父主题： 附录

配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称，用于识别不同的密钥。 类型 选择签名密钥的认证类型，可选择“HMAC”、“Basic Auth”、“AES”和“Public Key”。 在实例的配置参数中开启“public_key_enable”功能后，才支持选择“Public Key”类型。 签名算法 选择aes的签名算法，包含以下两种： aes-128-cfb aes-256-cfb Key 根据选择的密钥类型，填写不同的密钥信息。 HMAC：填写APP认证所使用密钥对的Key。 Basic Auth：填写basic认证所使用的用户名。 aes：填写aes认证所使用的密钥key。 Public Key：填写public_key认证所使用的公钥。 Secret 根据选择的密钥类型，填写不同的密钥信息。 HMAC：填写APP认证所使用密钥对的Secret。 Basic Auth：填写basic认证所使用的密码。 aes：填写aes认证所使用的向量。 Public Key：填写Public Key认证所使用的私钥。 确认Secret 填写与Secret一致的值。

为凭据绑定流量控制策略 已创建凭据，或已获取其他凭据ID。 在流控策略详情页面，单击“特殊凭据”页签，进入特殊凭据页面。 单击“添加特殊凭据”，弹出“添加特殊凭据”对话框。 通过以下两种方式，添加特殊凭据。 添加已有凭据：单击“已有凭据”，选择已有凭据，输入阈值。 添加其他凭据：单击“其他”，输入其他用户的凭据ID和阈值。 特殊凭据流控值和凭据流量限制值共同作用时，以特殊凭据流控值为准。 例如：API流量限制值为10，凭据流量限制值为3，时长为1分钟，特殊凭据（凭据A）流控值为2，特殊凭据（凭据B）流控值为4，凭据A在1分钟内最多可以访问绑定了该流控策略的API 2次，凭据B在1分钟内最多可以访问绑定了该流控策略的API 4次。

配置参数说明 表1 配置参数说明 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控针对单个API进行流量统计和控制； 共享流控针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。 与“API流量限制”配合使用，表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用，表示单位时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用，表示单位时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用，表示单位时间内的单个IP地址请求次数上限。 API流量限制 单个API被调用次数上限。 与“时长”配合使用，表示单位时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限，仅在API的安全认证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用，表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API，按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限，仅在API的安全认证方式为APP认证时适用。 不超过“用户流量限制”和“API流量限制”。 与“时长”配合使用，表示单位时间内的凭据请求次数上限。 源IP流量限制 单个IP地址调用API次数上限。 不超过“API流量限制”。 与“时长”配合使用，表示单位时间内的IP地址请求次数上限。 描述 关于控制策略的描述。

为租户绑定流量控制策略 在流控策略详情页面，单击“特殊租户”，进入特殊租户页面。 单击“添加特殊租户”，弹出“添加特殊租户”对话框。 输入租户信息。 表2 特殊租户信息 信息项 描述 租户ID 获取的账号ID或项目ID，请参考表1中的“特殊租户”说明。 阈值 固定时间段内，此租户访问API的最大值。 不能超过API流量限制值。 单击“确定”，完成特殊租户的添加。 特殊租户流控值和用户流量限制值共同作用时，以特殊租户流控值为准。 例如：API流量限制值为10，用户流量限制值为3，时长为1分钟，特殊租户（租户ID为A）流控值为2，特殊租户（租户ID为B）流控值为4，租户A在1分钟内最多可以访问绑定了该流控策略的API 2次，租户B在1分钟内最多可以访问绑定了该流控策略的API 4次。

脚本配置示例 { "response_headers": [ { "name": "test", "value": "test", "action": "append" }, { "name": "test1", "value": "test1", "action": "override" } ] }

配置参数说明 表1 配置参数说明 信息项 描述 Name 响应头名称。每个策略中不能添加重复名称的响应头（不区分大小写），且最多添加10条响应头。 Value 响应头的值。当“Action”为“Delete”时响应头的值不生效，可为空。 Action 响应头操作，您可以覆盖、添加、删除、跳过或新增指定的响应头。 Override：覆盖 当API响应中存在指定的响应头时，使用当前响应头的值覆盖已有响应头的值。 当API响应中存在多个与指定响应头相同名称的响应头时，该操作只会按当前响应头的值返回一条响应头记录。 当API响应中不存在指定的响应头时，添加当前响应头。 Append：添加 当API响应中存在指定的响应头时，将当前响应头的值添加到已有响应头值之后，用逗号分隔。 当API响应中存在多个与指定响应头相同名称的响应头时，会将多个响应头的值用“，”拼接后，再添加当前响应头的值。 当API响应中不存在指定的响应头时，添加当前响应头。 Delete：删除 当API响应中存在指定的响应头时，删除当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时，删除所有相同名称的响应头。 Skip：跳过 当API响应中存在指定的响应头时，跳过当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时，均不作处理直接返回。 当API响应中不存在指定的响应头时，添加当前响应头。 Add：新增 无论API响应中是否存在指定的响应头，都添加当前响应头。

导入到已有分组注意事项 将API定义导入到一个已有的分组，导入过程中不会删除分组中已有的API，只是将新增的API导入分组。 适用于将一个新的API或者一个修改后的API导入到已有的分组。 导入API前，请注意以下事项： API网关中API的配额满足需求。 导入的API定义与已有的API定义冲突时，您可以选择使用导入的API定义覆盖已有的API定义，或者保留已有的API定义，此时导入的API定义会显示导入失败。 如果选择扩展覆盖，当导入API的扩展定义项名称与已有策略（ACL，流量控制等）名称相同时，则会覆盖已有策略（ACL，流量控制等）。 导入的API不会自动发布到环境，导入时可以选择“立即发布”或者“稍后发布”，您可以自行选择策略。

导入到新分组注意事项 将API定义导入到一个新的分组，导入过程中系统会自动创建一个新的API分组，并将导入的API归属到该分组。 适用于将一份全新且完整的API导入到API网关。 导入API前，请注意以下事项： API网关中API分组和API的配额满足需求。 使用Swagger info或OpenAPI info的title作为API分组名称，新创建的API分组名称不能与已有的API分组名称重名。 导入的API定义中，如果存在冲突，那么根据系统导入的先后顺序，先导入的API会显示导入成功，后导入的API会显示导入失败。例如导入的API定义中存在2个名称相同或请求路径相同的API，那么先导入的API会显示导入成功，后导入的会显示导入失败。 如果选择扩展覆盖，当导入API的扩展定义项名称与已有策略（ACL，流量控制等）名称相同时，则会覆盖已有策略（ACL，流量控制等）。 导入的API不会自动发布到环境，导入时可以选择“立即发布”或者“稍后发布”，您可以自行选择策略。

前提条件 在调用API前，确保您的业务系统所在网络与API的访问域名或地址互通。 如果业务系统与API网关在相同VPC内时，可直接访问API。 如果业务系统与API网关在同一区域的不同VPC内时，可通过创建VPC对等连接，将两个VPC的网络打通，实现同一区域跨VPC访问API。具体步骤请参考VPC对等连接说明。 如果业务系统与API网关在不同区域的不同VPC内时，可通过创建云连接实例并加载需要互通的VPC，将两个VPC的网络打通，实现跨区域跨VPC访问API。具体步骤请参考跨区域VPC互通。 如果业务系统与API网关通过公网互通，请确保API网关已绑定弹性IP。

调用API 本章节仅提供请求地址和认证参数的配置指导，客户端的其他参数配置需要用户自行调整，如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损，建议参考业界标准进行配置。 构造API请求，示例如下： POST https://{Address}/{Path}?{Query} {Header} { {Body} } POST：请求方法，需替换为获取API的调用信息中获取的请求方法。 {Address}：请求地址，需替换为获取API的调用信息中获取的域名地址。 API调用场景 API请求参数配置 使用域名调用API 使用服务分配的调试域名或服务绑定的域名调用API，无需另外配置。 使用IP调用DEFAULT分组的API API允许使用IP地址调用DEFAULT分组下的API，无需另外配置。 使用IP调用非DEFAULT分组的API 使用IP地址直接调用非DEFAULT分组下的APP认证的API： 将实例的配置参数“app_route”和“app_secret”设置为“on”。开启“app_route”之后，同一凭据不能授权给相同请求路径和方法的API。 在请求消息中添加Header参数“X-HW-ID”和“X-HW-APPKEY”，参数值为API所授权凭据的Key和Secret。 须知： 使用简易认证（APP认证）调用API时，仅需在请求消息中添加Header参数“X-Apig-AppCode”和“host”即可。 使用IP地址直接调用非DEFAULT分组下的非APP认证的API，需要在请求消息中添加Header参数“host”。 {Path}：请求路径，需替换为获取API的调用信息中获取的请求路径。 {Query}：查询参数，可选，格式为“参数名=参数取值”，例如limit=10，多个查询参数之间使用“&”隔开。需根据获取API的调用信息中获取的请求参数进行设置。 {Header}：请求头参数，格式为“参数名: 参数取值”，例如Content-Type: application/json。需根据获取API的调用信息中获取的请求参数进行设置。 {Body}：请求消息体，JSON格式。需根据获取API的调用信息中获取的请求体内容描述进行设置。 为API请求添加认证信息。 API认证方式 API请求参数配置 APP认证（签名认证） 使用获取的SDK对API请求进行签名，具体请参考使用APP认证调用API。 APP认证（简易认证） 在API请求中添加Header参数“X-Apig-AppCode”，参数值为获取API的调用信息中获取到的AppCode。具体请参考快速入门。 APP认证（app_api_key认证） 实例的配置参数“app_api_key”已设置为“on”，开启app_api_key认证。 在API请求中添加Header或Query参数“apikey”，参数值为获取API的调用信息中获取到的Key。 APP认证（app_secret认证） 实例的配置参数“app_secret”已设置为“on”，开启app_secret认证，且“app_api_key”已设置为“off”，关闭app_api_key认证。 在API请求中添加Header参数“X-HW-ID”，参数值为获取API的调用信息中获取到的Key。 在API请求中添加Header参数“X-HW-AppKey”，参数值为获取API的调用信息中获取到的Secret。 APP认证（app_basic认证） 实例的配置参数“app_basic”已设置为“on”，开启app_basic认证。 在API请求中添加Header参数“Authorization”，参数值为"Basic"+base64(appkey+":"+appsecret)，其中appkey和appsecret分别为获取API的调用信息中获取到的Key和Secret。 APP认证（app_jwt认证） 实例的配置参数“app_jwt”已设置为“on”，开启app_jwt认证。 在API请求中添加Header参数“Timestamp”，参数值为当前时间的Unix时间戳，单位为毫秒。 在API请求中添加Header参数“Authorization”，参数值为sha256(appkey+appsecret+timestamp)，且sha256加密后的字符串需为小写字母。其中appkey和appsecret分别为获取API的调用信息中获取到的Key和Secret，timestamp为当前时间的Unix时间戳，单位为毫秒。 在API请求中添加Header参数“X-HW-ID”，参数值为获取API的调用信息中获取到的Key。 APP认证（双重认证） 在API请求中同时携带APP认证和自定义认证的认证信息。 IAM认证（Token认证） 先获取云服务平台的认证Token，然后在API请求中添加Header参数“X-Auth-Token”，参数值为认证Token，具体请参考Token认证。 IAM认证（AK/SK认证） 使用获取的SDK对API请求进行签名，具体请参考AK/SK认证。 IAM认证（双重认证） 在API请求中同时携带IAM认证和自定义认证的认证信息。 自定义认证 根据自定义认证的定义，在API请求参数中携带相关认证信息进行认证。 无认证 无需认证，可直接调用API。 第三方认证（API策略） 向API提供者获取请求参数中要携带的第三方认证信息。

脚本配置示例 { "auth_request": { "method": "GET", "protocol": "HTTPS", "url_domain": "192.168.10.10", "timeout": 5000, "path": "/", "vpc_channel_enabled": false, "vpc_channel_info": null }, "custom_forbid_limit": 100, "carry_body": { "enabled": true, "max_body_size": 1000 }, "auth_downgrade_enabled": true, "carry_path_enabled": true, "return_resp_body_enabled": false, "carry_resp_headers": [], "simple_auth_mode_enabled": true, "match_auth": null, "rule_enabled": false, "rule_type": "allow" }