云服务器内容精选

  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "apis" : [ { "run_env_name" : "RELEASE", "group_name" : "api_group_001", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "throttle_apply_id" : "3e06ac135e18477e918060d3c59d6f6a", "name" : "Api_http", "apply_time" : "2020-08-03T12:25:52Z", "remark" : "Web backend API", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "5f918d104dc84480a75166ba99efff21", "type" : 1, "throttle_name" : "throttle_demo", "auth_type" : "APP", "req_uri" : "/test/http" } ] } 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:throttle_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.3005", "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiForThrottle objects 本次查询返回的API列表 表5 ApiForThrottle 参数 参数类型 描述 auth_type String API的认证方式 group_name String API所属分组的名称 publish_id String API的发布记录编号 throttle_apply_id String 与流控策略的绑定关系编号 apply_time String 已绑定的流控策略的绑定时间 remark String API描述 run_env_id String 发布的环境id type Integer API类型 throttle_name String 绑定的流控策略名称 req_uri String API的访问地址 run_env_name String 发布的环境名 group_id String API所属分组的编号 name String API名称 id String API编号 req_method String API请求方法 枚举值: GET POST DELETE PUT PATCH HEAD OPTIONS ANY 状态码: 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 错误描述
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-apis 表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 throttle_id 是 String 流控策略编号 env_id 否 String 环境的ID group_id 否 String API分组编号 api_id 否 String API编号 api_name 否 String API名称
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiForThrottle objects 本次查询返回的API列表 表5 ApiForThrottle 参数 参数类型 描述 auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark String API描述 run_env_id String 发布的环境id id String API编号 req_uri String API的请求地址 type Integer API类型 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_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 错误描述 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "apis" : [ { "run_env_name" : "RELEASE", "group_name" : "api_group_001", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "throttle_apply_id" : "3e06ac135e18477e918060d3c59d6f6a", "name" : "Api_http", "apply_time" : "2020-08-03T12:25:52Z", "remark" : "Web backend Api", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "5f918d104dc84480a75166ba99efff21", "type" : 1, "throttle_name" : "throttle_demo", "auth_type" : "APP", "req_uri" : "/test/http" } ] } 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:throttle_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.3005", "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiForThrottle objects 本次查询返回的API列表 表5 ApiForThrottle 参数 参数类型 描述 auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark String API描述 run_env_id String 发布的环境id id String API编号 req_uri String API的请求地址 type Integer API类型 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_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 错误描述 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "total" : 2, "size" : 2, "apis" : [ { "run_env_name" : "RELEASE", "group_name" : "api_group_001", "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_mock", "remark" : "Mock backend API", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "3a955b791bd24b1c9cd94c745f8d1aad", "type" : 1, "auth_type" : "IAM", "req_uri" : "/test/mock" }, { "run_env_name" : "RELEASE", "group_name" : "APIGroup_d00511069", "publish_id" : "0c613568c8644a1b92172156f77a5759", "group_id" : "d7d0b9a54469424f942e16a6b6026936", "name" : "API_nevj", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "9e07bc00a1864ab4aafd4a23d19dd1c2", "type" : 1, "auth_type" : "APP", "req_uri" : "/fdasf" } ] } 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:throttle_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.3005", "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 对象模型 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数 类型 说明 操作类型 是否必选 id String 绑定关系的ID R - throttle_id String 流控策略的ID CR 是 front_api_id String API的编号 CR 是 env_id String 绑定的环境编号 CR 是 create_time Timestamp 绑定时间 R - 父主题: API绑定流控策略
  • 对象模型 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数 类型 说明 操作类型 是否必选 id String 绑定关系的ID R - throttle_id String 流控策略的ID CR 是 front_api_id String API的编号 CR 是 env_id String 绑定的环境编号 CR 是 create_time Timestamp 绑定时间 R - 父主题: API绑定流控策略(待下线)