华为云用户手册

  • 响应参数 状态码: 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: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.3024", "error_msg" : "The VPC instance does not exist,id:be63c6260a1043888187f84af39c9f0e" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "throttles" : [ { "name" : "throttle_demo", "create_time" : "2020-07-31T08:44:02.205366118Z", "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second", "type" : 1, "time_interval" : 1, "ip_call_limits" : 600, "app_call_limits" : 300, "time_unit" : "SECOND", "api_call_limits" : 800, "id" : "3437448ad06f4e0c91a224183116e965", "user_call_limits" : 500, "enable_adaptive_control" : "FALSE", "bind_num" : 0, "is_inclu_special_throttle" : 2 } ] } 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:name. 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" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 throttles Array of ThrottlesInfo objects 本次查询到的流控策略列表 表5 ThrottlesInfo 参数 参数类型 描述 app_call_limits Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 name String 流控策略名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 time_unit String 流控的时间单位 枚举值: SECOND MINUTE HOUR DAY remark String 流控策略描述字符长度不超过255。 说明: 中文字符必须为UTF-8或者unicode编码。 api_call_limits Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制,系统默认配额为200tps,用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 type Integer 流控策略的类型 1:基础,表示绑定到流控策略的单个API流控时间内能够被调用多少次。 2:共享,表示绑定到流控策略的所有API流控时间内能够被调用多少次。 枚举值: 1 2 enable_adaptive_control String 是否开启动态流控: TRUE FALSE 暂不支持 user_call_limits Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval Integer 流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。 ip_call_limits Integer 源IP流量限制是指一个API在时长之内被每个IP访问的次数上限,该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 id String 流控策略的ID bind_num Integer 流控绑定的API数量 is_inclu_special_throttle Integer 是否包含特殊流控配置 1:包含 2:不包含 枚举值: 1 2 create_time 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 错误描述 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttles 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 id 否 String 流控策略编号 name 否 String 流控策略名称 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name
  • 响应示例 状态码: 200 OK { "sign_secret" : "dc0************2b3", "update_time" : "2020-08-03T03:50:14.989785802Z", "create_time" : "2020-08-03T03:39:38Z", "name" : "signature_demo", "id" : "0b0e8f456b8742218af75f945307173c", "sign_key" : "a071a20d460a4f639a636c3d7e3d8163", "sign_type" : "hmac" } 状态码: 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:name. 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.3017", "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist" } 状态码: 412 PreconditionFailed { "error_code" : "APIG.3548", "error_msg" : "sign_type=public_key not supported by instance 6a29d4e9-69a0-412a-aabe-9898ec0903b0" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • URI PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 sign_id 是 String 签名密钥编号
  • 响应示例 状态码: 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName: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.3010", "error_msg" : "The access control policy binding record does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 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}/acl-bindings/{acl_bindings_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 acl_bindings_id 是 String 绑定关系编号
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 eip_id String 弹性公网IP编号 eip_address String 弹性公网IP eip_status String 弹性公网IP状态 eip_ipv6_address String 弹性公网IP(IPV6) 状态码: 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 错误描述
  • 响应示例 状态码: 200 OK { "eip_id" : "85392b45-685c-4f77-b19a-14ad875b8190", "eip_address" : "xxx.xxx.xxx.xxx", "eip_status" : "ACTIVE" } 状态码: 400 Bad Request { "error_code" : "APIC.7211", "error_msg" : "Parameter value does not match the rules, parameter name[eip_id]" } 状态码: 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" } 状态码: 404 Not Found { "error_code" : "APIC.7302", "error_msg" : "Instance not found" } 状态码: 500 Internal Server Error { "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }
  • 响应示例 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName: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.3013", "error_msg" : "Excluded request throttling configuration a3e9ff8db55544ed9db91d8b048770c0 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 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}/throttles/{throttle_id}/throttle-specials/{strategy_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 throttle_id 是 String 流控策略的编号 strategy_id 是 String 特殊配置的编号
  • 响应示例 状态码: 200 OK { "total" : 2, "size" : 1, "connections" : [ { "id" : "76ad893c-6a1e-4055-8019-fe9c9bd3204d", "marker_id" : 167960098, "created_at" : "2021-04-29T02:12:44Z", "updated_at" : "2021-04-29T02:12:45Z", "domain_id" : "b70fde8e849b4e76a61dd8aa0ec05c81", "status" : "accepted" } ] } 状态码: 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" } 状态码: 404 Resource Not Found { "error_code" : "APIC.7314", "error_msg" : "Endpoint service not found" } 状态码: 500 Internal Server Error { "error_code" : "APIC.9007", "error_msg" : "Failed to execute VCPEP request" }
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/connections 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 id 否 String 终端节点的ID,唯一标识 marker_id 否 Integer 终端节点的报文标识 status 否 String 终端节点的连接状态 pendingAcceptance 待接受 accepted 已接受 rejected 已拒绝 failed 失败 枚举值: pendingAcceptance accepted rejected failed
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 x-request-id String 请求编号 表5 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 connections Array of EndpointConnection objects 连接列表 表6 EndpointConnection 参数 参数类型 描述 id String 连接编号 marker_id Integer 连接报文标识 created_at String 连接创建时间。UTC时间,格式:YYYY-MM-DDTHH:MM:SSZ updated_at String 连接更新时间。UTC时间,格式:YYYY-MM-DDTHH:MM:SSZ domain_id String 用户的Domain ID status String 连接状态 pendingAcceptance 待接受 creating 创建中 accepted 已接受 rejected 已拒绝 failed 失败 deleting 删除中 枚举值: pendingAcceptance creating accepted rejected failed deleting 状态码: 401 表7 响应Header参数 参数 参数类型 描述 x-request-id String 请求编号 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表9 响应Header参数 参数 参数类型 描述 x-request-id String 请求编号 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表11 响应Header参数 参数 参数类型 描述 x-request-id String 请求编号 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表13 响应Header参数 参数 参数类型 描述 x-request-id String 请求编号 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI POST /v2/{project_id}/apigw/instances/{instance_id}/apis/debug/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 api_id 是 String API的编号
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request String 调试请求报文内容 response String 调试响应报文内容,响应消息体最大支持2097152字节,超过部分会被截断 说明: 响应消息体超过限制长度时,超过部分会被截断,并追加"[TRUNCATED]"信息。 latency Integer 调试耗时,单位:毫秒 log String 调试过程日志 状态码: 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 错误描述
  • 响应示例 状态码: 200 OK { "request" : "GET /test/mock HTTP/1.1\nHost: c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com\nUser-Agent: APIGatewayDebugClient/1.0\nX-Apig-Mode: debug\n\n", "response" : "HTTP/1.1 200 OK\nTransfer-Encoding: chunked\nConnection: keep-alive\nContent-Type: application/json\nDate: Mon, 03 Aug 2020 02:51:22 GMT\nServer: api-gateway\nX-Apig-Latency: 0\nX-Apig-Ratelimit-Api: remain:99,limit:100,time:1 minute\nX-Apig-Ratelimit-Api-Allenv: remain:14999,limit:15000,time:1 second\nX-Request-Id: d4ec6e33148bdeffe8f55b43472d1251\n\nmock success", "latency" : 5, "log" : "" } 状态码: 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:mode. 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 3a955b791bd24b1c9cd94c745f8d1aad does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 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:app_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.3004", "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号
  • 响应示例 状态码: 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" } 状态码: 404 Not Found { "error_code" : "APIC.7302", "error_msg" : "Instance not found" } 状态码: 500 Internal Server Error { "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }
  • 响应参数 状态码: 401 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 configs Array of Config objects 配额列表 表5 Config 参数 参数类型 描述 config_id String 配额编号 config_name String 配额名称 枚举值: API_NUM_LIMIT APP_NUM_LIMIT APIGROUP_NUM_LIMIT ENVIRONMENT_NUM_LIMIT VARIABLE_NUM_LIMIT SIGN_NUM_LIMIT THROTTLE_NUM_LIMIT APIGROUP_DOMAIN_NUM_LIMIT API_VERSION_NUM_LIMIT VPC_NUM_LIMIT VPC_INSTANCE_NUM_LIMIT API_PARAM_NUM_LIMIT API_USER_CALL_LIMIT ACL_NUM_LIMIT APP_THROTTLE_LIMIT USER_THROTTLE_LIMIT API_NUM_LIMIT_PER_GROUP API_POLICY_NUM_LIMIT API_CONDITION_NUM_LIMIT SL_DOMAIN_CALL_LIMIT ELB_SWITCH AUTHORIZER_NUM_LIMIT AUTHORIZER_IDENTITY_NUM_LIMIT APP_CODE_NUM_LIMIT REGION_MANAGER_WHITELIST_SERVICES API_SWAGGER_NUM_LIMIT API_TAG_NUM_LIMIT LTS_SWITCH APP_KEY_SECRET_SWITCH RESPONSE_NUM_LIMIT CONFIG_NUM_LIMIT_PER_APP BACKEND_TOKEN_ALLOW_SWITCH APP_TOKEN_SWITCH API_DESIGNER_SWITCH APP_API_KEY_SWITCH APP_BASIC_SWITCH APP_JWT_SWITCH APP_ROUTE_SWITCH PUBLIC_KEY_SWITCH APP_SECRET_SWITCH CASCADE_SWITCH IS_INIT_API_PATH_HASH config_value String 配额值 当前实例所在租户该配额对应的数量 config_time String 配额创建时间 remark String 配额描述: API_NUM_LIMIT:租户可以创建的API个数限制 APP_NUM_LIMIT:租户可以创建的APP个数限制 APIGROUP_NUM_LIMIT:租户可以创建的API分组个数限制 ENVIRONMENT_NUM_LIMIT:租户可以创建的环境个数限制 VARIABLE_NUM_LIMIT:每个API分组上可以创建的环境变量个数限制 SIGN_NUM_LIMIT:租户可以创建的签名密钥个数限制 THROTTLE_NUM_LIMIT:租户可以创建的流控策略个数限制 APIGROUP_DOMAIN_NUM_LIMIT:每个API分组上可以绑定的自定义域名个数限制 API_VERSION_NUM_LIMIT:每个API可以保留的发布版本个数限制 VPC_NUM_LIMIT:租户可以创建的VPC通道个数限制 VPC_INSTANCE_NUM_LIMIT:每个VPC通道上可以绑定的弹性云服务器个数限制 API_PARAM_NUM_LIMIT:每个API可以设置的参数个数限制 API_USER_CALL_LIMIT:每个租户的API单位时间内的请求默认限制 ACL_NUM_LIMIT:每个租户可以创建的ACL策略个数限制 APP_THROTTLE_LIMIT:特殊应用流控策略个数限制 USER_THROTTLE_LIMIT:特殊用户流控策略个数限制 API_NUM_LIMIT_PER_GROUP:租户每个API分组可以创建的API数量限制 API_POLICY_NUM_LIMIT:每个API可以设置的策略后端个数限制 API_CONDITION_NUM_LIMIT:每个API策略后端可以设置的条件个数限制 SL_DOMAIN_CALL_LIMIT:每个二级域名单位时间内的请求默认限制 ELB_SWITCH:是否启用ELB通道 AUTHORIZER_NUM_LIMIT:租户可创建的自定义认证个数限制 AUTHORIZER_IDENTITY_NUM_LIMIT:每个自定义认证可以设置的身份来源个数限制 APP_CODE_NUM_LIMIT:每个APP可以创建的APP code数量限制 REGION_MANAGER_WHITELIST_SERVICES:不校验region manager服务白名单列表,暂不支持 API_SWAGGER_NUM_LIMIT:单个API分组可以绑定的swagger文档数量限制 API_TAG_NUM_LIMIT:每个API可以设置的标签个数限制 LTS_SWITCH:是启用LTS上报 APP_KEY_SECRET_SWITCH:是否打开APP支持自定义KEY和SECRET的开关,1:开启;2:关闭 RESPONSE_NUM_LIMIT:分组自定义响应个数限制 CONFIG_NUM_LIMIT_PER_APP:每个APP可以设置的配置项个数限制 BACKEND_TOKEN_ALLOW_SWITCH:是否支持普通租户透传后端token,1:开启;2:关闭 APP_TOKEN_SWITCH:是否启用APPTOKEN API_DESIGNER_SWITCH:是否启用api设计器,1:开启;2:关闭 APP_API_KEY_SWITCH:是否启用APP_API_KEY认证方式 APP_BASIC_SWITCH:是否启用APP_BASIC认证方式 APP_JWT_SWITCH:是否启用APP_JWT认证方式 APP_ROUTE_SWITCH:是否启用APP路由 PUBLIC_KEY_SWITCH:是否启用PUBLIK_KEY后端认证方式 APP_SECRET_SWITCH:是否启用APP_SECRET认证方式 CASCADE_SWITCH:是否启用级联网关 IS_INIT_API_PATH_HASH:是否执行过API PATH HASH刷新 used Long 该实例对应配额已使用数量 状态码: 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 错误描述
  • 响应示例 状态码: 200 OK { "total" : 43, "size" : 2, "configs" : [ { "config_id" : "9", "config_name" : "API_VERSION_NUM_LIMIT", "config_value" : "10", "config_time" : "2019-02-12T19:42:19.914989Z", "remark" : "xxx", "used" : 0 }, { "config_id" : "8", "config_name" : "APIGROUP_DOMAIN_NUM_LIMIT", "config_value" : "5", "config_time" : "2019-02-12T19:42:19.914989Z", "remark" : "xxx", "used" : 0 } ] } 状态码: 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.3030", "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20
  • 响应示例 状态码: 200 OK { "create_time" : "2020-07-31T06:41:43Z", "name" : "DEV", "remark" : "Development environment", "id" : "7a1ad0c350844ee69479b47df9a881cb" } 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:name. 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.3003", "error_msg" : "Environment 7a1ad0c350844ee69479b47df9a881cb does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
共100000条