华为云用户手册

响应示例 状态码： 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.3068", "error_msg" : "Plugin b294018ee0554156a875b3513e02e5b9 does not exist"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "auths" : [ { "api_id" : "5f918d104dc84480a75166ba99efff21", "app_name" : "app_demo", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name" : "RELEASE", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "group_name" : "api_group_001", "api_type" : 1, "api_name" : "Api_http", "app_id" : "356de8eb7a8742168586e5daf5339965", "auth_time" : "2020-08-04T04:02:22Z", "app_creator" : "USER", "id" : "dd29b33ae4394e3b924b582c6b40880b", "api_remark" : "Web backend Api", "auth_role" : "PROVIDER", "app_type" : "apig", "auth_tunnel" : "NORMAL", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c" } ]} 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 auths Array of ApiAuthInfo objects 本次返回的API列表 表5 ApiAuthInfo 参数 参数类型 描述 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role String 授权者 auth_time String 授权创建的时间 app_name String APP的名称 app_remark String APP的描述 app_type String APP的类型： 默认为apig，暂不支持其他类型 app_creator String APP的创建者，取值如下： USER：租户自己创建 MARKET：API市场分配，暂不支持 publish_id String API的发布编号 group_id String API绑定的分组ID auth_tunnel String 授权通道类型 NORMAL：普通通道 GREEN：绿色通道 暂不支持，默认NORMAL auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array of strings 绿色通道的黑名单配置 visit_param String 访问参数。 roma_app_type String ROMA_APP的类型： subscription：订阅应用 integration：集成应用 暂不支持 tags Array of strings API绑定的标签，标签配额默认10条，可以联系技术调整。 最小长度：1 最大长度：128 数组长度：0 - 10 env_name String api授权绑定的环境名称 app_id String APP的编号 状态码： 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}/app-auths/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 app_id 是 String 应用编号 api_id 否 String API编号 api_name 否 String API名称 group_id 否 String API分组编号 group_name 否 String API分组名称 env_id 否 String 授权的环境编号 tags 否 String API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。 最小长度：0 最大长度：128

响应示例 状态码： 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 特殊配置的编号

URI GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-acls 表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 api_id 是 String API编号 env_id 否 String 环境编号 env_name 否 String 环境名称 acl_id 否 String ACL策略编号 acl_name 否 String ACL策略名称

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 acls Array of ApiBindAclInfo objects 本次查询返回的ACL列表 表5 ApiBindAclInfo 参数 参数类型 描述 acl_id String ACL策略编号 acl_name String ACL策略名称 entity_type String ACL策略作用的对象类型 acl_type String ACL策略类型 PERMIT：白名单类型 DENY：黑名单类型 acl_value String ACL策略值 env_id String 生效的环境编号 env_name String 生效的环境名称 bind_id String 绑定关系编号 bind_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, "acls" : [ { "acl_id" : "7eb619ecf2a24943b099833cd24a01ba", "acl_name" : "acl_demo", "entity_type" : "IP", "acl_type" : "PERMIT", "acl_value" : "192.168.1.5,192.168.10.1", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name" : "RELEASE", "bind_id" : "332c5db1458a477b89b2ea741fec94a3", "bind_time" : "2020-08-04T08:58:03Z" } ]} 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:acl_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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 success Array of Success objects 导入成功信息 failure Array of Failure objects 导入失败信息 swagger Swagger object swagger文档导入结果 暂不支持 group_id String API分组编号 ignore Array of Ignore objects 被忽略导入的API信息 表5 Success 参数 参数类型 描述 path String API请求路径 method String API请求方法 action String 导入行为： update：表示更新API create：表示新建API id String 导入成功的API编号 表6 Failure 参数 参数类型 描述 path String API请求路径 error_msg String 导入失败的错误信息 method String API请求方法 error_code String 导入失败的错误码 表7 Swagger 参数 参数类型 描述 id String swagger文档编号 result String 导入结果说明 表8 Ignore 参数 参数类型 描述 method String API请求方法 path String API请求路径 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 FormData参数 参数 是否必选 参数类型 描述 is_create_group 否 Boolean 是否创建新分组 缺省值：true group_id 否 String API分组编号，当is_create_group=false时为必填 extend_mode 否 String 扩展信息导入模式 merge：当扩展信息定义冲突时，merge保留原有扩展信息 override：当扩展信息定义冲突时，override会覆盖原有扩展信息 缺省值：merge simple_mode 否 Boolean 是否开启简易导入模式 缺省值：false mock_mode 否 Boolean 是否开启Mock后端 缺省值：false api_mode 否 String 导入模式 merge：当API信息定义冲突时，merge保留原有API信息 override：当API信息定义冲突时，override会覆盖原有API信息 缺省值：merge file_name 是 File 导入Api的请求体，json或yaml格式的文件

响应示例 状态码： 200 OK { "group_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2", "failure" : [ { "path" : "/test/demo", "error_msg" : "The API already exists, An API with the same combination of the method, path, and x-apigateway-match-mode fields already exists. API name: API_demo", "method" : "GET", "error_code" : "APIG.3301" } ], "success" : [ { "path" : "/test", "method" : "GET", "action" : "create", "id" : "8ae6bcafab6f49d78242bff26ad8a4f0" } ], "swagger" : { "id" : "e2ea8a7c1cfc49b3830437cb79d7fd59", "result" : "Success" }} 状态码： 400 Bad Request { "error_code" : "APIG.3201", "error_msg" : "The API group name already exists"} 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method"} 状态码： 404 Not Found { "error_code" : "APIG.3001", "error_msg" : "API group not found"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

URI GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/unbinded-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 sign_id 是 String 签名密钥编号 env_id 否 String 环境编号 api_id 否 String API编号 api_name 否 String API名称 group_id 否 String API分组编号 tags 否 String API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。 最小长度：0 最大长度：128

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "run_env_name" : "RELEASE", "group_name" : "api_group_001", "remark" : "Mock backend API", "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_mock", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "3a955b791bd24b1c9cd94c745f8d1aad", "type" : 1, "auth_type" : "IAM", "req_uri" : "/test/mock" } ]} 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiForSign objects 本次查询返回的API列表 表5 ApiForSign 参数 参数类型 描述 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的请求地址 tags Array of strings API绑定的标签，标签配额默认10条，可以联系技术调整。 最小长度：1 最大长度：128 数组长度：0 - 10 type Integer API类型 signature_name String 已绑定的签名密钥名称 req_method String API请求方法 状态码： 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的认证方式 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请求方法 tags Array of strings API绑定的标签，标签配额默认10条，可以联系技术调整。 最小长度：1 最大长度：128 数组长度：0 - 10 状态码： 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 OK { "total" : 1, "size" : 1, "apis" : [ { "api_id" : "5f918d104dc84480a75166ba99efff21", "api_name" : "Api_http", "group_name" : "api_group_001", "api_type" : 1, "api_remark" : "Web backend API", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name" : "RELEASE", "bind_id" : "332c5db1458a477b89b2ea741fec94a3", "bind_time" : "2020-08-04T08:58:03Z", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c" } ]} 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:api_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.3006", "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba 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 AclBindApiInfo objects 本次查询返回的API列表 表5 AclBindApiInfo 参数 参数类型 描述 api_id String API编号 api_name String API名称 api_type Long API类型 api_remark String API的描述信息 env_id String 生效的环境编号 env_name String 生效的环境名称 bind_id String 绑定关系编号 group_name String API分组名称 bind_time String 绑定时间 publish_id String API发布记录编号 req_method String API请求方法 tags Array of strings API绑定的标签，标签配额默认10条，可以联系技术调整。 最小长度：1 最大长度：128 数组长度：0 - 10 状态码： 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}/acl-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 acl_id 是 String ACL编号 api_id 否 String API编号 api_name 否 String API名称 env_id 否 String 环境编号 group_id 否 String API分组编号 tags 否 String API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。 最小长度：0 最大长度：128

响应示例 状态码： 200 OK { "name" : "Api_http", "type" : 1, "version" : "V0.0.1", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "auth_type" : "AUTHORIZER", "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "cors" : false, "match_mode" : "NORMAL", "backend_type" : "HTTP", "remark" : "Web backend API", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "result_normal_sample" : "Example success response", "result_failure_sample" : "Example failure response", "id" : "5f918d104dc84480a75166ba99efff21", "group_name" : "api_group_001", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "run_env_name" : "RELEASE", "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2", "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ]} 状态码： 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 5f918d104dc84480a75166ba99efff21 does not exist"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/runtime/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 api_id 是 String API的编号 表2 Query参数 参数 是否必选 参数类型 描述 env_id 否 String API的发布环境编号

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 name String API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。 说明： 中文字符必须为UTF-8或者unicode编码。 type Integer API类型 1：公有API 2：私有API version String API的版本 最大长度：16 req_protocol String API的请求协议 HTTP HTTPS BOTH：同时支持HTTP和HTTPS GRP CS 缺省值：HTTPS req_method String API的请求方式，当API的请求协议为GRPC类型协议时请求方式固定为POST。 req_uri String 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。 说明： 需要服从URI规范。 auth_type String API的认证方式 NONE：无认证 APP：APP认证 IAM：IAM认证 AUTHORIZER：自定义认证，当auth_type取值为AUTHORIZER时，authorizer_id字段必须传入 auth_opt AuthOpt object 认证方式参数 cors Boolean 是否支持跨域 TRUE：支持 FALSE：不支持 缺省值：false match_mode String API的匹配方式 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配） 默认：NORMAL backend_type String 后端类型 HTTP：web后端 FUNCTION： 函数工作流 ，当backend_type取值为FUNCTION时，func_info字段必须传入 MOCK：模拟的后端，当backend_type取值为MOCK时，mock_info字段必须传入 GRPC：grpc后端 remark String API描述。字符长度不超过255 说明： 中文字符必须为UTF-8或者unicode编码。 group_id String API所属的分组编号 body_remark String API请求体描述，可以是请求体示例、媒体类型、参数等信息。字符长度不超过20480 说明： 中文字符必须为UTF-8或者unicode编码。 result_normal_sample String 正常响应示例，描述API的正常返回信息。字符长度不超过20480 说明： 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 result_failure_sample String 失败返回示例，描述API的异常返回信息。字符长度不超过20480 说明： 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 authorizer_id String 前端自定义认证对象的ID tags Array of strings 标签。 支持英文，数字，中文，特殊符号（-*#%.:_），且只能以中文或英文开头。 默认支持10个标签，如需扩大配额请联系技术工程师修改API_TAG_NUM_LIMIT配置。 最小长度：1 最大长度：128 response_id String 分组自定义响应ID roma_app_id String 集成应用ID 暂不支持 domain_name String API绑定的自定义 域名 暂不支持 tag String 标签 待废弃，优先使用tags字段 content_type String 请求内容格式类型： application/json application/xml multipart/form-data text/plain is_send_fg_body_base64 Boolean 是否对与FunctionGraph交互场景的body进行Base64编码。仅当content_type为application/json时，可以不对body进行Base64编码。 应用场景： 自定义认证 绑定断路器插件，且断路器后端降级策略为函数后端 API后端类型为函数工作流 缺省值：true id String API编号 group_name String API所属分组的名称 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String 发布记录的编号 sl_domain String 分组的二级域名 sl_domains Array of strings 系统默认分配的子域名列表 req_params Array of ReqParam objects API的请求参数列表 表5 AuthOpt 参数 参数类型 描述 app_code_auth_type String AppCode简易认证类型，仅在auth_type为APP时生效，默认为DISABLE： DISABLE：不开启简易认证 HEADER：开启简易认证且AppCode位置在HEADER 缺省值：DISABLE 表6 ReqParam 参数 参数类型 描述 name String 参数名称。 长度为1 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required Integer 是否必须 1：是 2：否 location为PATH时，required默认为1，其他场景required默认为2 valid_enable Integer 是否开启校验 1：开启校验 2：不开启校验 缺省值：2 remark String 描述信息。长度不超过255个字符 说明： 中文字符必须为UTF-8或者unicode编码。 enumerations String 参数枚举值 min_num Integer 参数最小值 参数类型为NUMBER时有效 max_num Integer 参数最大值 参数类型为NUMBER时有效 min_size Integer 参数最小长度 参数类型为STRING时有效 max_size Integer 参数最大长度 参数类型为STRING时有效 regular String 正则校验规则 暂不支持 json_schema String JSON校验规则 暂不支持 pass_through Integer 是否透传 1：是 2：否 orchestrations Array of strings 请求参数匹配编排规则的生效优先级与列表顺序保持一致，列表中靠前的配置匹配优先级较高； 如果编排规则列表中包含none_value类型的规则，则none_value类型的规则优先级最高，至多绑定一个none_value类型的规则； 如果编排规则列表中包含default类型的规则，则default类型的规则优先级最低，至多绑定一个default类型的规则； 当编排规则为预处理策略时，该规则不能作为除default以外的最后一个编排规则； 每个API仅允许选择一个参数绑定编排规则，且编排规则不能重复，支持绑定的编排规则数量有配额限制，具体请参见产品介绍的“约束与限制”章节。 id 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 表3 响应Body参数 参数 参数类型 描述 authed_nums Integer 已进行API访问授权的APP个数 unauthed_nums Integer 未进行API访问授权的APP个数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

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

URI GET /v2/{project_id}/apigw/instances/{instance_id}/sign-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 sign_id 是 String 签名密钥编号 env_id 否 String 环境编号 api_id 否 String API的编号 api_name 否 String API名称 group_id 否 String API分组编号 tags 否 String API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。 最小长度：0 最大长度：128

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "bindings" : [ { "api_id" : "5f918d104dc84480a75166ba99efff21", "group_name" : "api_group_001", "binding_time" : "2020-08-03T04:00:11Z", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name" : "RELEASE", "sign_name" : "signature_demo", "api_type" : 1, "api_name" : "Api_http", "id" : "25082bd52f74442bb1d273993d567938", "api_remark" : "Web backend API", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c" } ]} 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 bindings Array of SignApiBindingBase objects 本次查询到的签名密钥和API绑定关系列表 表5 SignApiBindingBase 参数 参数类型 描述 publish_id String API的发布编号 api_id String API编号 group_name String API所属分组的名称 binding_time String 绑定时间 env_id String API所属环境的编号 env_name String API所属环境的名称 api_type Integer API类型 api_name String API名称 id String 绑定关系的ID api_remark String API描述 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 req_method String API请求方法 tags Array of strings API绑定的标签，标签配额默认10条，可以联系技术调整。 最小长度：1 最大长度：128 数组长度：0 - 10 状态码： 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 错误描述