云服务器内容精选

华为云首页用户手册

专享版-编排规则管理

API网关 APIG-查询编排规则绑定的API:响应示例

响应示例状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "api_id" : "8aa097b00e9843efabc9c593d11b769d", "api_name" : "api_demo", "req_method" : "GET", "req_uri" : "/test", "auth_type" : " IAM ", "match_mode" : "NORMAL", "group_id" : "b9be707660c5406394f8973e087bae20", "group_name" : "group_demo", "attached_time" : "2023-07-02T12:31:23.353Z" } ] } 状态码： 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:f0fa1789-3b76-433b-a787-9892951c620ec" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

API网关 APIG 专享版-编排规则管理
API网关 APIG-查询编排规则绑定的API:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of OrchestrationApiInfo objects 编排规则绑定的API列表。表5 OrchestrationApiInfo 参数参数类型描述 api_id String API编号。 api_name String API名称。支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。说明：中文字符必须为UTF-8或者unicode编码。 req_method String API的请求方式。 req_uri String 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ .等特殊字符，总长度不超过512，且满足URI规范。支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。说明：需要服从URI规范。 auth_type String API的认证方式。 NONE：无认证 APP：APP认证 IAM：IAM认证 AUTHORIZER：自定义认证 match_mode String API的匹配方式。 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配）默认：NORMAL group_id String API所属的分组编号。 group_name String API所属分组的名称。 attached_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 错误描述

API网关 APIG 专享版-编排规则管理
API网关 APIG-查询编排规则绑定的API:URI

URI GET /v2/{project_id}/apigw/instances/{instance_id}/orchestrations/{orchestration_id}/attached-apis 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 orchestration_id 是 String 编排规则编号表2 Query参数参数是否必选参数类型描述 offset 否 Long 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 limit 否 Integer 每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 api_name 否 String API名称。 api_id 否 String API编号。

API网关 APIG 专享版-编排规则管理