华为云用户手册

错误码 当您调用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.7254 IPv6 access not supported. 暂不支持IPv6。 暂不支持IPv6，请联系技术支持。 400 APIC.7255 IPv6 not supported for the subnet used when creating the gateway or enabling IPv6 access. 创建IPv6实例或开启IPv6时，子网不支持IPv6。 请尝试更换支持IPv6的子网。 400 APIC.7257 The custom inbound port is bound to a custom domain name. 自定义入方向端口存在绑定的自定义 域名 请将绑定了该自定义入方向端口的域名进行删除或者修改。 400 APIC.7312 The AZ does not support IPv6. 不存在支持IPv6功能的可用区 更换其他支持IPv6功能的可用区 400 APIC.7313 The bandwidth for IPv6 cannot be less than 5 MB. IPv6对应的带宽大小不能小于5M 增加传入的带宽大小 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 APIC.9223 Delete custom inbound port failed. 删除自定义入方向端口失败 请稍后重试或联系技术支持工程师协助解决 400 APIC.9224 Add custom inbound port 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.2046 Incorrect custom authentication timeout. 自定义认证的超时时间填写错误 修改自定义认证超时时间的值，其值必须小于或等于函数执行的超时时间以及V2接口超时时间600s 400 APIG.2047 Incorrect number of retries for custom authentication. 自定义认证的重试次数填写错误 修改自定义认证重试次数的值，其值应该在0到10的范围内 400 APIG.2048 Incorrect Nacos configurations. nacos配置填写错误 请使用正确的nacos配置 400 APIG.2049 The port is not in the defined custom inbound ports. 该端口未在自定义入方向端口中定义 请使用HTTP(s)协议默认端口访问，或者通过实例自定义入方向端口定义后再使用。 400 APIG.2050 The combination of this domain name and port already exists. 该域名及端口组合已存在 请指定其他域名或端口 400 APIG.2051 A domain name cannot be bound with different certificates. 相同域名无法绑定不同证书 请绑定相同的证书 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证书后再绑定 400 APIG.3717 Two-way TLS authentication not supported for HTTP or GRPC backend requests. API的后端请求协议为http或grpc时不支持开启TLS双向认证 请关闭TLS双向认证 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 APIC.7403 The number of custom inbound ports has reached the maximum. 自定义入方向端口的数量超过了允许的最大值 请申请自定义入方向端口的配额 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.3072 The specified task 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 E CS 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次。

操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待配置参数的实例上，单击“查看控制台”或实例名称。 单击“配置参数”页签，找到您需要调整的配置项并进行修改。不同的实例规格展示的配置参数会存在不同，具体以界面为准。 表1 实例配置参数说明 参数 说明 ratelimit_api_limits API全局默认流控值，默认值为200次/秒。API未绑定流控策略时，执行此默认流控；API绑定流控策略时，则执行绑定的流控策略。流控策略的API流量限制值不能超过API全局默认流控值。 request_body_size API请求中允许携带的Body大小上限，默认值为12MB，可修改范围为1MB~9536MB。 backend_timeout 后端响应超时时间上限，默认值为60000ms，可修改范围为1ms~600000ms。 app_token app_token认证方式开关，默认关闭。启用后，可在API请求中使用获取的access_token进行API的调用认证。 app_token_expire_time：access_token的有效时间，在access_token到期前，请及时获取新的access_token并更新，避免影响正常使用。 refresh_token_expire_time：refresh_token的有效时间。refresh_token用于获取新的access_token。 app_token_uri：获取access_token的uri。 app_token_key：access_token的加密key。 app_api_key app_api_key认证方式开关，默认关闭。启用后，可在API请求中添加“apikey”参数，携带凭据的Key进行API的调用认证。 app_basic app_basic认证方式开关，默认关闭。启用后，在API请求中添加Header参数“Authorization”，参数值为"Basic"+base64(appkey:appsecret)，其中appkey和appsecret分别为凭据的Key和Secret。 app_secret app_secret认证方式开关，默认关闭。启用后，可在API请求中添加“X-HW-ID”和“X-HW-AppKey”参数，携带凭据的Key和Secret进行API的调用认证。 app_route 支持IP访问开关，默认关闭。启用后，非DEFAULT分组下的APP认证的API可以使用IP地址调用。 backend_client_certificate 后端双向认证开关，默认关闭。启用后，创建API配置后端服务时，可配置后端双向认证。 ssl_ciphers 支持配置https加密套件，默认所有的加密套件全部支持。当您绑定独立域名后，可根据需要选择支持的加密套件。 real_ip_from_xff 是否使用X-Forwarded-For头中的IP作为ACL、流控的判断依据，默认不使用。 xff_index：X-Forwarded-For头中IP的排序序号，值允许为正数、负数、0。 xff_index值为0或正数时，获取X-Forwarded-For头中对应索引的IP。 xff_index值为负数时，按倒序方式从X-Forwarded-For头中获取IP。 例如到达API网关的X-Forwarded-For头中依次有IP1，IP2，IP3三个IP地址，xff_index取0时获取IP1，xff_index取1时获取IP2，xff_index取-1时获取IP3，xff_index取-2时获取IP2。 vpc_name_modifiable 负载通道名称是否可修改，默认可修改。 须知： 负载通道名称可修改时，当前实例的负载通道无法通过项目级负载通道管理接口操作。 app_jwt_enable app_jwt认证方式开关，默认关闭。启用后，可在API请求中添加“Authorization”和“Timestamp”参数，携带凭据的Key和Secret以及时间戳进行API的调用认证。 app_jwt_auth_header：app_jwt认证头，即API请求中携带app_jwt认证信息的Header参数，默认为Authorization。 public_key_enable public_key类型签名密钥开关，默认关闭。启用后，可在签名密钥认证中使用public_key类型签名。 public_key_uri_prefix：获取public_key对应secret的uri前缀。具体uri格式为：https://{虚拟私有云访问地址}{public_key_uri_prefix}{public_key签名密钥名称}。 custom_auth_header 认证头域自定义配置开关，默认关闭。启用后，参数“app_auth_header”和“backend_sign_header”的初始值为空，与不启用效果一致。 如果配置“app_auth_header”的“参数运行值”，那么对于APP认证的API，请求header中携带APP认证信息的参数为此处“app_auth_header”的值；如果配置“backend_sign_header”的“参数运行值”，那么对于绑定HMAC或者Basic Auth类型签名密钥策略的API，API网关到后端服务的请求header中携带签名信息的参数为此处“backend_sign_header”的值。 须知： 配置后会影响当前实例下所有APP认证或签名密钥策略（HMAC/Basic Auth类型），请谨慎配置。 gzip 对响应请求使用gzip压缩，用于减少公网流量。默认未配置gzip压缩，配置后1分钟生效，请谨慎修改。 启用后，可配置comp_level参数，comp_level表示压缩级别，值越大表示性能消耗越大，一般默认为6。 须知： 响应请求体大于1KB时，您可以使用gzip压缩文件（即1KB以下的文件不做压缩）。 gzip压缩支持的文件类型有text/xml、text/plain、text/css、application/javascript、application/x-javascript、application/rss+xml、text/javascript、image/tiff、image/svg+xml、application/json、application/xml 启用gzip压缩后，须在请求中添加请求头“Accept-Encoding: gzip”。 gzip配置完成后，如需修改，至少需要1分钟后。 custom_log 自定义日志功能开关，默认关闭。开启自定义日志功能后，实例下所有API的调用日志中会在指定位置打印指定参数的值。 启用后，需单击“编辑”，添加需在调用日志中打印的参数。 须知： 自定义日志只支持打印由客户端发起的请求信息，不支持打印在APIG中定义的常量参数和系统参数。 自定义日志最多可配置10个字段，且字段大小总和不得超过2KB。 参数值中的部分特殊字符会进行编码，例如：加号（+）会被编码为空格“ ”，双引号（"）会被编码为“\x22”，反斜杠（\）会被编码为“\x5C”。 sse_strategy SSE传输策略开关，默认关闭。启用后，支持通过使用Server-Sent Events (SSE)按照流式输出API的响应内容，可以实现逐字符渲染。 须知： sse_strategy配置完成后，如需修改，至少需要1分钟后。 request_custom_config 支持自定义配置客户端请求相关参数。 HTTP/2：HTTP/2协议的开关，默认为开启状态。更多详情请参考支持HTTP2.0。 request_body_timeout：客户端请求体超时时间的修改，默认为8s。网络状况差或请求体过大的情况下可适当调整该参数。 须知： 客户端请求自定义配置修改完成后，如需修改，至少需要1分钟后。 api_uri_no_escape API的URL中的Path转义处理开关。默认关闭，表示URL中的Path会进行转义处理。 开启“api_uri_no_escape”开关后，使用Path不转义的功能请参见表2。 表2 Path不转义影响的功能 功能 描述 API前端定义的Path 请求发送时使用的Path api_uri_no_escape开关关闭 api_uri_no_escape开关开启 API定义 APIG进行匹配路由的Path /{path} /aa%2Faa /aa/aa /aa%2Faa 参数编排 后端服务参数使用的Path - - /aa/aa /aa%2Faa http到https重定向 重定向使用的Path - - /aa/aa /aa%2Faa 策略后端 策略条件为请求入参的Path - - /aa/aa /aa%2Faa 第三方认证策略 API绑定第三方认证策略后，传递到第三方的Path - - /aa/aa /aa%2Faa kafka日志推送策略 API绑定kafka日志推送策略后，使用的请求Path - - /aa/aa /aa%2Faa 负载通道 使用URI哈希分发算法的负载通道时，APIG用来转发的Path - - /aa/aa /aa%2Faa FunctionGraph后端 API的后端类型为FunctionGraph时，发送到函数请求Path - - /aa/aa /aa%2Faa 自定义认证 API认证方式选择自定义认证时，发送到函数请求Path - - /aa/aa /aa%2Faa

脚本配置示例 { "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网关控制台页面。 在左侧导航栏选择“实例管理”。 在已创建的实例上，单击“查看控制台”或实例名称。 单击“终端节点管理”页签，查看终端节点信息，详细信息可参考终端节点管理。 表1 终端节点信息 参数 说明 服务信息 展示的名称由{region}.{终端节点服务名称}.{终端节点服务ID}组成。您在购买实例时，会同步创建 VPC终端节点 服务，可以设置终端节点服务名称，也可以在此处修改终端节点服务名称。 连接管理 展示连接到网关实例的终端节点信息。如果需要新建终端节点，请单击“创建终端节点”创建。 终端节点ID：终端节点的ID。 报文标识：终端节点ID的标识，用来识别是哪个终端节点。 状态：终端节点的状态。 关于终端节点的各个状态，请查看终端节点服务和终端节点有哪些状态？。 拥有者：终端节点创建者的账号ID。 创建时间：终端节点的创建时间。 操作：终端节点服务对终端节点的连接审批，可选择“接受”或“拒绝”。 须知： 如您仍有业务通过该连接进行访问，拒绝已建立的连接可能导致业务受损，请谨慎操作。 权限管理 权限管理用于控制是否允许跨租户的终端节点进行访问。可以设置允许连接该终端节点服务的授权账号ID，将授权账号ID添加至终端节点服务的白名单中。 单击“添加白名单记录”，填写账号ID。 授权账号ID：连接访问终端节点的授权账号ID。 创建时间：白名单的创建时间。 操作：对连接访问终端节点的授权账号进行操作，支持将授权账号从白名单中删除。

配置参数说明 表1 配置参数说明 参数 说明 Allowed Origins Access-Control-Allow-Origin响应头，指定允许访问API的外域URI，多个URI之间使用英文逗号隔开。 对于未携带身份凭证的请求，可以把参数值设置为“*”，表示允许来自所有域的访问请求。 Allowed Methods Access-Control-Allow-Methods响应头，指定允许使用的HTTP请求方法，多个请求方法之间使用英文逗号隔开。 Allowed Headers Access-Control-Allow-Headers响应头，指定XMLHttpRequest请求中允许携带的请求头字段，多个请求头之间使用英文逗号隔开。 其中，简单请求头Accept、Accept-Language、Content-Language、Content-Type（取值仅限为application/x-www-form-urlencoded、multipart/form-data、text/plain时）默认允许在请求中携带，无需在该参数中设置。 说明： 创建跨域资源共享策略时，默认不配置Allowed Headers，不允许跨域请求携带任何自定义请求头。 配置Allowed Headers为“*”，表示允许跨域请求头携带所有请求头。 Exposed Headers Access-Control-Expose-Headers响应头，指定XMLHttpRequest请求响应中允许携带的响应头字段，多个响应头之间使用英文逗号隔开。 其中，基本响应头Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma默认允许在响应中携带，无需在该参数中设置。 说明： 创建跨域资源共享策略时，默认不配置Exposed Headers，不允许浏览器的JavaScript代码解析跨域访问获得的响应头内容（除XMLHttpRequest对象的getResponseHeader()方法获得的基本响应头，Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma）。 配置Exposed Headers为“*”，表示允许浏览器的JavaScript代码解析跨域访问获得的所有响应头内容。 Maximum Age Access-Control-Max-Age响应头，指定本次预检请求的有效期，单位为秒。在有效期内，无需再次发出预检请求。 Allowed Credentials Access-Control-Allow-Credentials响应头，定XMLHttpRequest请求中是否允许携带Cookie。 开关开启表示允许。 开关关闭表示不允许。

脚本配置示例 { "allow_origin": "*", "allow_methods": "GET,POST,PUT", "allow_headers": "Content-Type,Accept,Accept-Ranges,Cache-Control", "expose_headers": "X-Request-Id,X-Apig-Latency", "max_age": 86400, "allow_credentials": true }

脚本配置示例 { "cache_key": { "system_params": [ "$context.sourceIp", "$context.requestId" ], "parameters": [ "demo_parameters" ], "headers": [ "demo_header" ] }, "cache_http_status_and_ttl": [ { "http_status": [ 200 ], "ttl": 300 } ], "client_cache_control": { "mode": "apps", "datas": [ "demo_app_id_1,demo_app_id_2" ] }, "cacheable_headers": [ "demo_cacheable_headers_1,demo_cacheable_headers_2" ] }

配置参数说明 表1 配置参数说明 参数 说明 响应缓存键 配置参数作为响应缓存键，用于区分不同的缓存。 system_params类型：配置不同的网关内置系统参数作为响应缓存键来区分缓存。配置参数请参考网关内置参数。 parameters类型：配置不同的请求query参数作为响应缓存键来区分缓存。 headers类型：配置不同的请求头作为响应缓存键来区分缓存。 HTTP参数 根据HTTP响应码和缓存时长来决定是否缓存，以及缓存的有效时间。 如果不配置HTTP参数，那么HTTP响应码默认值为200，取值范围：200-599。缓存时长默认值为300s，取值范围：1s~720000s。 缓存策略模式 网关通过客户端请求中的Cache-Control请求头来处理缓存，默认拒绝所有客户端带Cache-Control头的请求。 all：允许所有客户端带Cache-Control头的请求。 off：拒绝所有客户端带Cache-Control头的请求。 apps：允许appId（凭据ID）取值在datas列表中的客户端。 允许缓存的后端响应头 对于后端的响应Headers，默认仅支持缓存Content-Type，Content-Encoding，Content-Language头。如果需要缓存更多的Headers，请在“允许缓存的后端响应头”处添加，但是无法添加API网关增加的系统响应头（x-apig-*，x-request-id等）。

使用限制 单账号跟踪的事件可以通过 云审计 控制台查询。多账号的事件只能在账号自己的事件列表页面去查看，或者到组织追踪器配置的OBS桶中查看，也可以到组织追踪器配置的 CTS /system日志流下面去查看。 用户通过云审计控制台只能查询最近7天的操作记录。如果需要查询超过7天的操作记录，您必须配置转储到 对象存储服务 (OBS)或 云日志 服务(LTS)，才可在OBS桶或LTS日志组里面查看历史事件信息。否则，您将无法追溯7天以前的操作记录。 云上操作后，1分钟内可以通过云审计控制台查询管理类事件操作记录，5分钟后才可通过云审计控制台查询数据类事件操作记录。

配置参数说明 表1 配置参数说明 参数 说明 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址：限制调用API的IP地址。 账号名：仅适用IAM认证类型的API，限制调用API的账号名。仅支持配置账号名，对账号名及账号名下的IAM用户名做限制，不支持配置IAM用户名。 可以配置单账号名或多账号名，多账号名以英文格式下的“,”隔开，账号名支持除英文格式下“,”以外的任意ASCII字符，账号名长度限制在1-64个字符，不支持纯数字。多账号名字符的总长度不超过1024。 账号ID：仅适用IAM认证类型的API，限制调用API的账号ID。仅支持配置账号ID，对账号ID及账号ID下的IAM用户ID做限制，不支持配置IAM用户ID。 可以配置单账号ID或多账号ID，多账号ID以英文格式下的“,”隔开。账号ID为英文字母、数字组成的32位字符；多账号ID字符的总长度不超过1024。 说明： 一个API同时绑定两种类型的访问控制策略：账户维度的账户名类型和账号ID类型。访问API时，如果同时有黑白名单，只校验白名单，校验通过则访问成功；如果只有黑名单或白名单，校验通过的结果为“且”逻辑。 一个API同时绑定三种类型的访问控制策略：IP维度的IP类型、账户维度的账号名类型和账号ID类型。访问API时，IP维度和账户维度为“且”的关系，其中一方校验失败则访问失败。（一个API同时绑定IP类型和账号名/账号ID类型的访问控制策略，这两种类型的判断逻辑与三种类型的判断逻辑相同）。 动作 包括“允许”和“禁止”。 和“类型”配合使用，允许/禁止访问API的IP地址/账号名/账号ID。 IP地址 仅当“类型”为“IP地址”时需要配置。 输入允许或者禁止访问API的IP地址，或IP地址范围。 说明： 允许或禁止访问的IP地址条数，分别可以配置最多100条。 账号名 仅当“类型”为“账号名”时需要配置。 输入允许或者禁止访问API的账号名，多个账号名之间使用英文逗号（,）隔开。 您可以单击控制台右上角的用户名，选择“我的凭证”，在“我的凭证”页面获取用户的账号名。 账号ID 仅当“类型”为“账号ID”时需要配置。 输入允许或者禁止访问API的账号ID，多个账号ID之间使用英文逗号（,）隔开。 您可以单击控制台右上角的用户名，选择“我的凭证”，在“我的凭证”页面获取用户的账号ID。

使用AppCode进行API请求的简易认证 在创建API时，选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证，需要在修改完成后，将API重新发布，使简易认证模式生效。 将支持简易认证的API绑定到已创建的凭据。 发送请求时，增加请求头部参数“X-Apig-AppCode”，省略请求签名相关信息。 以Curl方式为例，增加头部参数名称：X-Apig-AppCode，参数值填已生成的AppCode。 curl -X GET "https://api.exampledemo.com/testapi" -H "content-type: application/json" -H "host: api.exampledemo.com" -H "X-Apig-AppCode: xhrJVJKABSOxc7d***********FZL4gSHEXkCMQC"

开放API 企业或开发者通过API网关开放自身的服务与数据，实现业务能力变现。 图2 开放API基本流程 创建实例 实例是一个独立的资源空间，所有的操作都是在实例内进行，不同实例间的资源相互隔离。 创建API分组 每个API都归属到某一个API分组下，在创建API前应提前创建API分组。 绑定域名 在开放API前，您需要为API分组绑定一个独立域名，供API调用者访问API使用。 在绑定独立域名前，您可以使用系统为API分配的调试域名进行API调试，每天最多可以访问调试域名1000次。 创建API 把已有后端服务封装为标准RESTFul API，并对外开放。 API创建成功后，您可根据业务需求对API设置访问策略： 传统策略 流控控制 流量控制可限制单位时间内API的被调用次数，保护后端服务。 访问控制 访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 签名密钥 签名密钥用于后端服务验证API网关的身份，在API网关请求后端服务时，保障后端服务的安全。 插件策略 跨域资源共享策略说明 跨域资源共享策略为跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的扩展能力，可快速、灵活的实现API的跨域访问。 响应缓存策略说明 您可以通过配置响应缓存策略将后端服务返回的应答缓存在API网关中，当客户端发送相同的请求时，网关不用向后端传递请求，直接返回缓存的应答。 HTTP响应头管理策略说明 您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 流量控制2.0策略说明 您可以限制单位时间内API的被调用次数，支持参数流控、基础流控和基于基础流控的特殊流控。 Kafka日志推送策略说明 Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力，方便用户获取API的调用日志信息。 断路器策略说明 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。 第三方认证策略说明 您可以通过第三方认证策略配置自己的鉴权服务为API的访问进行认证。 调试API 验证 API服务 的功能是否正常可用。 发布API 把API发布到环境中，API只有在发布到环境后，才支持被调用。

操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待查看或编辑的实例上，单击“查看控制台”或实例名称。 在“实例信息”页签，查看或编辑实例的配置信息。 表1 实例信息 可编辑项 说明 基本信息 实例的基本信息，包括实例名称、实例ID、实例规格、可用区、描述、企业项目和时间窗。 用户可以根据实际需要修改“实例名称”、“描述”等。 用户可以单击“实例ID”右侧的复制实例ID信息。 计费信息 实例的计费模式。 网络配置 虚拟私有云 实例所关联的VPC，用户可以单击VPC名称跳转查看VPC的具体配置信息。 子网 实例所关联的子网，用户可以单击子网名称跳转查看子网的具体配置信息。 安全组 实例所关联的安全组，用户可以单击安全组名称跳转查看安全组的具体配置信息，也可以单击，绑定新的安全组。 访问控制 API网关提供实例级的访问控制策略，您可以通过设置IP地址的黑白名单来禁止/允许某个IP地址访问实例。IP地址说明如下： 常规IP格式，如：127.0.0.1、::1 IP加掩码，如：192.145.0.0/16、2407:c080:17ef:ffff::3104:703a/64 IP段范围，如：127.0.0.1-192.145.0.1、2407:c080:17ef:ffff::3104:703a-2407:c080:17ef:ffff::3104:704a 访问控制策略最多支持设置100个IP地址或网段，且最大长度为5120。 如果使用IPv6地址，请先确保对应实例支持IPv6协议。 如果不开启访问控制策略，默认允许所有IP访问；如果开启访问控制策略，设置“白名单”类型，但是没有配置任何IP地址，则禁止任何IP访问；如果开启访问控制策略，设置“黑名单”类型，但是没有配置任何IP地址，则允许任何IP访问。 安全组策略、实例级访问控制策略和API级访问控制策略遵循Deny优先原则。 入口地址 虚拟私有云访问地址 弹性IP地址 如果实例未绑定弹性IP地址，您可以单击地址右侧的“立即启用”，绑定弹性IP地址。 如果实例已绑定弹性IP地址，您可以单击地址右侧的复制地址信息。 如果实例已绑定弹性IP地址，您可以编辑公网带宽。公网带宽费用按小时计算，以弹性公网IP服务的价格为准。 如果实例已绑定弹性IP地址，您可以单击地址右侧的“解绑EIP”，解绑弹性IP地址。 出口地址 指允许实例API的后端服务部署在外部网络，API网关为实例开启公网出口。公网出口可随时关闭或开启。 开启公网出口后，您可以单击“查看带宽监控”查看数据，也可编辑出公网带宽。 路由 配置私有网段。实例创建完成后，默认能够与创建时指定的VPC子网网段进行互通。如果有额外的私有网段需要与实例互通，可通过该配置项进行路由配置。 如果本地数据中心的子网不在以下三个大子网段内，暂时不支持配置本地路由：10.0.0.0/8-24、172.16.0.0/12-24、192.168.0.0/16-24。

脚本配置示例 { "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" }

配置参数说明 表1 配置参数说明 参数 说明 负载通道 是否使用负载通道作为第三方接口的鉴权服务。 选择“使用”时，配置鉴权服务的负载通道。 选择“不使用”时，配置鉴权服务的访问地址。 后端URL 请求方法 支持GET、POST、PUT、HEAD请求方法。 请求协议 HTTP或HTTPS，传输重要或敏感数据时推荐使用HTTPS。 负载通道（可选） 仅在“使用”负载通道时，需要设置。选择已创建的负载通道名称，如果没有可选的负载通道，您也可以单击“新建负载通道”创建。 后端服务地址（可选） 仅在不使用负载通道时，需要设置。 填写鉴权服务的访问地址，格式：“主机:端口”。主机为鉴权服务的访问IP地址/域名，未指定端口时，HTTP协议默认使用80端口，HTTPS协议默认使用443端口。 说明： 目前仅支持IPv4地址。 路径 鉴权服务的路径，即服务的url。 后端超时（ms） 鉴权服务请求的超时时间。超时时间不超过后端响应超时时间上限，超时时间上限可在API网关控制台的“配置参数”中查看。 自定义host头域 仅在使用负载通道时配置。 在请求被发送到负载通道中的云服务器前，允许您自定义请求的host头域，默认将使用请求中原始的host头域。 防暴力拦截阈值 当源IP访问在5分钟内进行第三方认证失败的次数达到此处配置的阈值时，将触发源IP请求拦截，在这5分钟后解除请求拦截。 例如，5分钟内，源IP访问在第三分钟进行第三方认证失败的次数达到此处配置的阈值，触发源IP请求拦截，再过2分钟解除请求拦截。 身份来源 将从API原始请求中获取此处配置的参数进行第三方鉴权接口鉴权（最大支持10个header参数和10个query参数）。身份来源信息为空时，携带API原始请求的请求参数（header参数和query参数）调用第三方鉴权接口进行鉴权。 宽松模式 开关开启后，当鉴权服务不可用（与鉴权服务建立连接失败或者鉴权服务返回5xx）时，API网关仍然接受客户端请求。 允许携带原始请求体 开关开启后，将携带API原始请求体调用鉴权接口鉴权。 请求体大小（字节） 仅在开启“允许携带原始请求体”时配置。 请求体大小不能超过实例允许的最大请求体大小。实例的最大请求体大小可在API网关控制台“配置参数”中查看。 允许携带原始请求路径 开关开启后，将API原始请求路径拼接到鉴权接口路径之后调用鉴权接口鉴权。 直接返回鉴权响应 开关开启后，鉴权失败时，将直接返回鉴权服务的响应。 允许携带的响应头部 鉴权成功时，原始请求将从鉴权服务返回的响应头中获取此处配置的头部，传到业务后端。 最大支持配置10个头部。 简易鉴权模式 开关开启后，鉴权服务返回状态码“2xx”时，表示认证通过。 鉴权结果匹配 仅在“简易鉴权模式”关闭后可配置。 根据鉴权服务返回的响应头中的参数名和参数值进行校验，响应头中存在此处配置的参数名，并且参数值相等则认证通过。 黑白名单配置 开关开启后，原始API请求匹配黑/白名单规则将进行/不进行第三方认证鉴权。 规则类型 白名单规则 如果原始API请求匹配白名单规则，将不进行第三方认证鉴权。 黑名单规则 如果原始API请求匹配黑名单规则，将进行第三方认证鉴权。 定义参数 定义用于规则的参数。 参数位置：用于规则匹配的参数位置。 path：API请求的URI，系统默认配置。 method：API请求方法，系统默认配置。 header：请求头的key值。 query：QueryString的key值。 system：系统参数。 参数：用于判断与规则中的参数值是否匹配。 定义规则 定义用于规则的判断条件。 单击“添加规则”，编辑规则名称和规则条件。在“条件表达式”弹窗中，选择“定义参数”中的参数名和判断条件，以及输入参数值。 =为等于 !=为不等于 pattern为正则表达式 enum为枚举值，多个参数值之间用英文逗号分隔

实例计费方式更改 支持实例包周期和按需计费方式互换。注意包周期转按需计费生效的前提是包周期已到期。 在左侧导航栏单击“实例管理”。 在需要更改计费方式的实例上，单击“更多”，选择“转包周期”或“转按需”。 按需转包周期：选择续费时长，单击“去支付”，完成付款即可。 包周期转按需：包周期转按需生效的前提是包周期已到期，包周期转按需操作可在包周期到期前或包周期到期后的冻结期内执行。单击“转按需”即可。

操作步骤 进入购买实例页面。 除墨西哥城一、北京一区域外，在其他区域购买实例后默认开启ELB负载。开启ELB负载的实例的安全组不生效，如需禁用部分IP请使用访问控制策略。 开启ELB负载：ELB作为网关入口的负载均衡器，入口支持跨VPC访问。但在开启公网入口时，弹性IP地址由网关随机分配，不支持选择已有弹性IP地址。 根据下表参数说明，配置实例参数。 表1 API网关实例参数说明 参数 说明 计费模式 实例收费方式，当前支持“按需计费”和“包周期”两种方式。 目前仅北京一、北京四、乌兰察布一、上海一、上海二、广州、广州-友好用户环境和贵阳一支持包周期收费方式。 区域 指APIG实例部署的区域，建议和您其他的业务部署在相同区域，这样不同的业务可以在负载内以子网方式通信，节省公网带宽成本，降低网络延时。 可用区 指同一区域内电力、网络等资源物理隔离的地理区域，一般为互相独立的机房。 APIG实例支持同时选择多个可用区，进行跨可用区部署，提升实例高可用性。 APIG不支持跨可用区迁移实例。 实例名称 实例的名称，根据规划自定义。 实例规格 当前开放基础版、专业版、企业版、铂金版实例。不同实例规格，对API请求的并发支持能力不同，具体请参考《API网关产品介绍》的规格说明章节。 说明： 目前仅上海一和北京四区域支持选择更多铂金版规格。 可维护时间窗 指允许云服务技术支持对实例进行维护的时间段。如果有维护需要，技术支持会提前与您沟通确认。 建议选择业务量较少的时间段。 企业项目 使用企业用户登录时，可选择实例所属企业项目。 有关企业项目的资源使用、迁移以及用户权限等，请参考《企业管理用户指南》。 公网入口 指允许外部服务通过弹性IP地址，调用实例创建的API。开启“公网入口”，需要绑定一个“弹性IP地址”，弹性IP地址另行收费。 说明： 在北京四、上海一、广州、贵阳一区域开启公网入口后，弹性IP地址由网关随机分配，不支持选择已有弹性IP地址。您可以根据业务预估设置合适的“入公网带宽”，入公网带宽费用按小时计算，以弹性IP服务的价格为准。 您需要使用独立域名/调试域名访问，使用调试域名访问时存在单日访问次数限制。可在创建API分组后，为分组绑定独立域名，独立域名需要解析到实例的弹性IP地址。 例如您有一个API，请求协议为HTTPS，Path为/apidemo，开启了公网访问，并为分组绑定了独立域名后，可使用https://{domain}/apidemo这个URL访问您的API。其中，{domain}表示已绑定到分组的独立域名，目标端口443可默认缺省。 公网出口 指允许API的后端服务部署在外部网络，APIG为实例开启公网出口。您可以根据业务预估设置合适的“出公网带宽”，出公网带宽费用按小时计算，以弹性IP服务的价格为准。 IPv6 仅在计费模式为“按需计费”时，需要配置。 如果后端服务部署在外部网络，且需要使用IPv6地址访问，则需要勾选“支持IPv6”。 说明： 目前仅北京四支持。 网络 指为实例绑定到一个VPC，并为其分配子网。 使用已创建的VPC和子网，请在下拉列表选择当前账号下创建的VPC和子网。 使用共享VPC和子网，请在下拉列表选择其他账号共享给当前账号的VPC和子网。 共享VPC基于 资源访问管理 （Resource Access Manager，简称 RAM ）服务的机制，VPC的所有者可以将VPC内的子网共享给一个或者多个账号使用。通过共享VPC功能，可以简化网络配置，帮助您统一配置和运维多个账号下的资源，有助于提升资源的管控效率，降低运维成本。有关VPC子网共享的更多信息，请参见共享VPC。 使用新的VPC和子网，请单击“控制台”，参考创建虚拟私有云创建待使用的新VPC和子网。 安全组 安全组用于设置端口访问规则，定义哪些端口允许被外部访问，以及允许访问外部哪些地址与端口。 例如，后端服务部署在外部网络，则需要设置相应的安全组规则，允许访问后端服务地址与API调用端口。 说明： 如果开启公网入口，安全组入方向需要放开80（HTTP）和443（HTTPS）端口的访问权限。 终端节点服务名称 填写终端节点服务名称。购买实例后，同步创建VPC终端节点服务，可以被终端节点连接和访问。 如果填写了终端节点服务名称，购买实例后，在实例详情中的“终端节点管理”页签下展示名称为{region}.{终端节点服务名称}.{终端节点服务ID}；如果终端节点服务名称为空，购买实例后，在实例详情中的“终端节点管理”页签下展示名称为{region}.{apig}.{终端节点服务ID}。 标签 通过标签对实例资源进行标记，批量分类实例资源，实现对实例资源进行分组查询、分析及管理。如果没有标签选择可单击“查看预定义标签”创建，也可以直接输入标签键值创建。 实例创建完成后，也可以在管理标签中设置。 说明： 如您的组织已经设定API网关服务的相关标签策略，则需按照标签策略规则为实例添加标签。标签如果不符合标签策略的规则，则可能会导致创建实例失败，请联系组织管理员了解标签策略详情。 购买时长 计费模式为“包年/包月”时配置。实例的购买时长，最短1个月。 描述 实例的描述信息。 单击“立即购买”，进入实例规格确认页面。 规格确认无误后，勾选服务协议，支付费用后，开始创建实例，界面显示创建进度。

网络环境准备 负载 虚拟私有云（Virtual Private Cloud，简称VPC）。实例需要配置虚拟私有云（负载），在同一负载中的资源（如ECS），可以使用实例的私有地址调用API。 在创建实例时，建议配置和您其他关联业务相同负载，确保网络安全的同时，方便网络配置。 创建实例后，不支持修改虚拟私有云（负载）。 弹性公网IP 实例的API如果要允许外部调用，则需要创建一个弹性公网IP，并与实例绑定，作为实例的公网入口。 如果API的后端服务部署在公网，还需要有公网出口访问权限，这由API网关统一规划，不需要单独创建弹性公网IP。 安全组 安全组类似防火墙，控制谁能访问实例的指定端口，以及控制实例的通信数据流向指定的目的地址。安全组入方向规则建议按需开放地址与端口，这样可以保护实例的网络安全。 实例绑定的安全组有如下要求： 入方向：如果需要从公网调用API，或从其他安全组内资源调用API，则需要为实例绑定的安全组的入方向放开80（HTTP）、443（HTTPS）两个端口。 出方向：如果后端服务部署在公网，或者其他安全组内，则需要为实例绑定的安全组的出方向放开后端服务地址与API调用端口。 如果API的前后端服务与实例绑定了相同的安全组、相同的虚拟私有云，则无需专门为实例开放上述端口。

购买的约束说明 创建实例存在一些约束，当您登录后无法创建实例，或者创建失败，请参考以下约束说明进行检查，并解除限制。 实例配额 同一项目ID下，一个主账号默认只能创建5个实例。如果您需要创建更多实例，可提交工单，申请修改配额。 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略，则拥有“APIG FullAccess”即可。 如果使用自定义策略，请参考对用户组授权。 子网中可用私有地址数量 API网关专享实例的基础版、专业版、企业版，以及铂金版分别需要3、5、6、7个私有地址。在铂金版的基础上，铂金版X依次增加4个私有地址。请确保您选择的子网段有足够多的私有地址可用，私有地址可在虚拟私有云服务的控制台查询。

后续操作 确认APIG实例已添加路由。通过同一个VPC（有扩展网段等）、对等连接等方式连接CCE负载与APIG实例的网络时，需要添加路由。 进入云容器引擎控制台，在“集群管理”页面单击已创建的CCE集群名称。 在“总览”页面的“网络信息”区域查看“容器网段”，并记录。 进入API网关控制台，在“实例管理”页面单击对应的实例名称。 在“实例信息”页面的“路由”区域查看已添加的路由与容器网段是否一致。如果不一致，请添加。 创建API，将部署在负载中的后端服务开放API。

方案概述 在整个产品生命周期管理中，缺陷管理是非常关键的一环。无论是硬件系统还是软件开发，都难免遇到不计其数的缺陷，如果缺陷管理不善，产品质量势必大打折扣。华为基于多年沉淀的质量运营管理经验，打造出一套行之有效的缺陷管理优秀实践，为团队提供统一、高效、风险可视的缺陷跟踪平台，确保每一个缺陷都被高质高效闭环。 某公司计划推出一款智能手表，研发周期较长，研发过程涉及多个部门、多团队的协作，如何保证缺陷在多个组织间的流转、最终达到有效闭环呢？本文介绍如何通过IPD系统设备类项目来模拟智能手表研发项目进行缺陷管理。

方案概述 产品从规划到上市要经过复杂的研发过程，CodeArts Req提供了基线评审和变更管理能力，实现需求基线-受控变更-变更评审-变更管理的过程化管理，让基线变更如门禁一样，达到阈值才能启动下一步，确保产品研发“做正确的事”。 某公司计划推出一款智能手表，涉及多部门、多团队的协作，且已经过前期的多轮需求沟通与澄清，将研发需求分配到各产研团队。为保障产品如期保质交付，需要确保不同研发生产团队都忠实执行任务，按照既定的需求进行研发落地。这时就需要对需求进行基线管控，基线后的需求不允许随意更改。本文介绍如何通过IPD系统设备类项目来模拟智能手表研发项目进行基线评审管理。

操作流程 模拟案例的基本操作流程如下： 表1 CodeArts Req原始需求管理实践操作流程说明 流程 说明 步骤一：新建原始需求 将客户诉求转化成原始需求在项目中进行新建跟踪。 步骤二：决策原始需求 原始需求的分析责任人对需求进行分析决策。 步骤三：研发与交付原始需求 原始需求关联的子需求在开发交付时，也就是原始需求的在研和交付。 步骤四：验收原始需求 原始需求交付完成后，需要需求提出人对其进行验收。

方案概述 成功产品的核心特征是满足客户需求，客户需求是企业发展的原动力。CodeArts Req打破了传统需求管理工具仅在研发阶段发挥作用的限制，将客户与市场需求也同步覆盖，提供了完整的客户需求采集、价值需求决策、交付与验收流程，让需求进展和动态客户实时透明，市场需求流动提速70%。 在CodeArts Req的原始需求管理中，用户可以将客户诉求提交至目标组织，目标组织对需求进行决策、分析、交付及后续验收流程全程实时透明化，可以加速客户诉求的交付速率，提升产品在市场上的竞争力。本文介绍如何通过IPD系统设备类项目来模拟智能手表研发项目进行原始需求管理。

步骤一：获取私有依赖库地址与配置 获取私有依赖库地址。 进入私有依赖库，选择“仓库视图”，并在左侧边栏中选择目标Maven私有依赖库。 单击仓库名称，右侧页面中仓库的“概览”页签中详细信息显示“仓库地址”。单击即可复制仓库地址。 图2 获取私有依赖库地址 获取私有依赖库配置。 单击页面右上方“操作指导”。 在“操作指导”对话框中单击“下载配置文件”，下载配置文件settings.xml至本地。 图3 下载配置文件 在本地打开配置文件settings.xml，在文件中搜索并找到如下红框中的用户名与密码。