# 查询API列表 - ListApisV2 #### 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息和API请求参数信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ROMA/doc?api=ListApisV2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-roma/roma_06_0018.html)。 #### URI GET /v2/{project_id}/apic/instances/{instance_id}/apis 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方式请参见API参考的"附录 \> 获取项目ID"章节。 | | instance_id | 是 | String | 实例ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Long | 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 | | limit | 否 | Integer | 每页显示的条目数量 | | id | 否 | String | API编号 | | name | 否 | String | API名称 | | group_id | 否 | String | API分组编号 | | req_protocol | 否 | String | 请求协议 | | req_method | 否 | String | 请求方法 | | req_uri | 否 | String | 请求路径 | | auth_type | 否 | String | 授权类型。 - NONE：无认证 - APP：APP认证 - IAM：IAM认证 - AUTHORIZER：自定义认证 | | env_id | 否 | String | 发布的环境编号 | | type | 否 | Integer | API类型 - 1：公有API - 2：私有API | | precise_search | 否 | String | 指定需要精确匹配查找的参数名称，多个参数需要支持精确匹配时参数之间使用","隔开。 目前仅支持name，req_uri，vpc_channel_name。 | | vpc_channel_id | 否 | String | 负载通道编号 | | vpc_channel_name | 否 | String | 负载通道名称。 | | roma_app_name | 否 | String | 集成应用名称 | | roma_app_id | 否 | String | 集成应用编号 | | return_data_mode | 否 | String | 指定API详情中需要包含的额外返回结果，多个参数之间使用","隔开，当brief和其他include参数共同使用时，brief不生效。 目前仅支持brief，include_group，include_group_backend。 brief：默认值，不包含额外信息。 include_group：返回结果中包含api_group_info。 include_group_backend：返回结果中包含backend_api。 | | tags | 否 | String | API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | 本次返回的列表长度 | | total | Long | 满足条件的记录数 | | apis | Array of [ApiInfoPerPage] objects | 本次查询到的API列表 | 表5ApiInfoPerPage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头。 说明： 中文字符必须为UTF-8或者unicode编码。 | | type | Integer | API类型 - 1：公有API - 2：私有API | | version | String | API的版本 | | req_protocol | String | API的请求协议 - HTTP - HTTPS - BOTH：同时支持HTTP和HTTPS - GRPCS | | req_method | String | API的请求方式，当API的请求协议为GRPC类型协议时请求方式固定为POST。 | | req_uri | String | 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 \* % - _ .等特殊字符，总长度不超过512，且满足URI规范。 当API的请求协议为GRPC类型时请求地址固定为/。 /apic/health_check为服务集成预置的健康检查路径，当req_method=GET时不支持req_uri=/apic/health_check。 说明： 需要服从URI规范。 | | auth_type | String | API的认证方式 - NONE：无认证 - APP：APP认证 - IAM：IAM认证 - AUTHORIZER：自定义认证，当auth_type取值为AUTHORIZER时，authorizer_id字段必须传入 | | auth_opt | [AuthOpt] object | 认证方式参数 | | cors | Boolean | 是否支持跨域 - TRUE：支持 - FALSE：不支持 | | trace_enabled | Boolean | 是否开启链路追踪，默认关闭。 | | sampling_strategy | String | 采样策略，当选择开启链路追踪时，此字段必填。 - RATE：按比例采样 | | sampling_param | String | 采样参数。 - 当采样策略为RATE时，此字段取值为字符串化的整数，范围为0-100，缺省为'100'，'100'为采集每个请求，建议与后端应用的采样率保持一致。 | | 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请求体描述，可以是请求体示例、媒体类型、参数等信息。 说明： 中文字符必须为UTF-8或者unicode编码。 | | result_normal_sample | String | 正常响应示例，描述API的正常返回信息。 说明： 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 | | result_failure_sample | String | 失败返回示例，描述API的异常返回信息。 说明： 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 | | authorizer_id | String | 前端自定义认证对象的ID | | tags | Array of strings | 标签。 支持英文、数字、中文、特殊符号（-\*#%.:_），且只能以中文或英文开头。 默认支持10个标签，如需扩大配额请联系技术工程师修改API_TAG_NUM_LIMIT配置。 | | response_id | String | 分组自定义响应ID 暂不支持 | | roma_app_id | String | API归属的集成应用编号 API分组为全局分组时或API绑定自定义域名时必填。 | | domain_name | String | API绑定的自定义域名，使用自定义域名时roma_app_id字段必填。 | | 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后端类型为函数工作流 | | id | String | API编号 | | status | Integer | API状态 - 1： 有效 - 2: 锁定 | | arrange_necessary | Integer | 是否需要编排：1,是;2,否 | | register_time | String | API注册时间 | | update_time | String | API修改时间 | | group_name | String | API所属分组的名称 | | group_version | String | API所属分组的版本 | | run_env_name | String | 发布的环境名称 存在多个发布记录时，环境名称之间用\|隔开 | | run_env_id | String | 发布的环境编号 存在多个发布记录时，环境编号之间用\|隔开 | | publish_id | String | 发布记录编号 存在多个发布记录时，发布记录编号之间用\|隔开 | | publish_time | String | 发布时间 存在多个发布记录时，发布时间之间用\|隔开 | | roma_app_name | String | API归属的集成应用名称 | | ld_api_id | String | 当API的后端为自定义后端时，对应的自定义后端API编号 | | backend_api | [BackendApi] object | 后端信息 | | api_group_info | [ApiGroupCommonInfo] object | api分组信息 | | req_params | Array of [ReqParam] objects | API的请求参数列表 | 表6AuthOpt | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app_code_auth_type | String | AppCode简易认证类型，仅在auth_type为APP时生效，默认为DISABLE： - DISABLE：不开启简易认证 - HEADER：开启简易认证且AppCode位置在HEADER | 表7BackendApi | 参数 | 参数类型 | 描述 | |:---|:---|:---| | authorizer_id | String | 后端自定义认证对象的ID | | url_domain | String | 后端服务的地址。不使用vpc通道时,url_domain为必填。 由主机（IP或域名）和端口号组成，总长度不超过255。格式为主机:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443，HTTP默认端口号为80。 支持环境变量，使用环境变量时，每个变量名的长度为3 \~ 32位的字符串，字符串由英文字母、数字、下划线、中划线组成，且只能以英文开头 | | req_protocol | String | 请求协议，后端类型为GRPC时请求协议可选GRPC、GRPCS。当vpc_channel_status取值为1或者2时，该字段必填。 | | remark | String | 描述。 说明： 中文字符必须为UTF-8或者unicode编码。 | | req_method | String | 请求方式，后端类型为GRPC时请求方式固定为POST。当vpc_channel_status取值为1或者2时，该字段必填。 | | version | String | web后端版本，字符长度不超过16 | | req_uri | String | 请求地址，当vpc_channel_status取值为1或者2时，该字段必填。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 \* % - _ .等特殊字符，总长度不超过512字符，且满足URI规范。 支持环境变量，使用环境变量时，每个变量名的长度为3\~32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。 说明： 需要服从URI规范。 后端类型为GRPC时请求地址固定为/。 | | timeout | Integer | 服务集成请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000 单位：毫秒。 | | enable_client_ssl | Boolean | 是否开启双向认证 | | retry_count | String | 请求后端服务的重试次数，默认为-1，范围\[-1,10\]。 当该值为-1时，幂等的接口会重试1次，非幂等的不会重试。POST，PATCH方法为非幂等；GET，HEAD，PUT，OPTIONS和DELETE等方法为幂等的。 | | enable_sm_channel | Boolean | 是否启用SM商密通道。 仅实例支持SM系列商密算法的实例时支持开启。 | | member_group_url_infos | Array of [MemberGroupUrlInfo] objects | 后端服务器分组详细信息，当vpc_channel_status取值为4时，该字段必填。 | | id | String | 编号 | | status | Integer | 后端状态 - 1： 有效 | | register_time | String | 注册时间 | | update_time | String | 修改时间 | | vpc_channel_info | [VpcInfo] object | VPC通道详情。如果vpc_channel_status = 1或4，则这个object类型为必填信息 | | vpc_channel_status | Integer | 负载类型。 - 1：使用VPC通道，单模后端 - 2：不使用VPC通道 - 3: livedata - 4：使用VPC通道，多模后端 | 表8MemberGroupUrlInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | member_group_id | String | 后端服务器分组ID。 | | req_protocol | String | 请求协议。 | | req_method | String | 请求方式。 | | req_uri | String | 请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 \* % - _ . 等特殊字符，总长度不超过512字符，且满足URI规范。 支持环境变量，使用环境变量时，每个变量名的长度为3\~32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。 说明： 需要服从URI规范。 | 表9VpcInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ecs_id | String | 云服务器ID | | ecs_name | String | 云服务器名称 | | cascade_flag | Boolean | 是否使用级联方式 暂不支持 | | vpc_channel_proxy_host | String | 代理主机 | | vpc_channel_id | String | VPC通道编号 | | vpc_channel_port | Integer | VPC通道端口 | 表10ApiGroupCommonInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编号 | | name | String | API分组名称 | | status | Integer | 状态 - 1： 有效 - 2: 锁定 | | sl_domain | String | 系统默认分配的子域名 | | register_time | String | 创建时间 | | update_time | String | 最近修改时间 | | on_sell_status | Integer | 是否已上架云市场： - 1：已上架 - 2：未上架 - 3：审核中 ROMA Connect暂未对接云市场，此字段默认返回2 | | url_domains | Array of [UrlDomain] objects | 分组上绑定的独立域名列表 | | sl_domain_access_enabled | Boolean | 调试域名是否可以访问，true表示可以访问，false表示禁止访问 | 表11UrlDomain | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 域名编号 | | domain | String | 访问域名 | | cname_status | Integer | 域名cname状态： - 1：未解析 - 2：解析中 - 3：解析成功 - 4：解析失败 | | ssl_id | String | SSL证书编号 | | ssl_name | String | SSL证书名称 | | min_ssl_version | String | 最小ssl协议版本号。支持TLSv1.1或TLSv1.2 | | verified_client_certificate_enabled | Boolean | 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 | | is_has_trusted_root_ca | Boolean | 是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。 | | ssl_infos | Array of [SslInfo] objects | SSL证书列表 | 表12SslInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ssl_id | String | SSL证书编号 | | ssl_name | String | SSL证书名称 | | algorithm_type | String | 证书算法类型： - RSA - ECC - SM2 | | type | String | 证书可见范围： - instance：当前实例 - global：全局 | 表13ReqParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 参数名称。 由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。 | | type | String | 参数类型 - STRING：字符串型 - NUMBER：数字型 | | location | String | 参数位置 | | default_value | String | 参数默认值 | | sample_value | String | 参数示例值 | | required | Integer | 是否必须 - 1：是 - 2：否 location为PATH时，required默认为1，其他场景required默认为2 | | valid_enable | Integer | 是否开启校验 - 1：开启校验 - 2：不开启校验 | | remark | String | 描述信息。 说明： 中文字符必须为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 | 参数编号 | **状态码：400** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：401** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：403** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：404** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 无 #### 响应示例 **状态码：200** OK ``` { "total" : 1, "size" : 1, "apis" : [ { "name" : "Api_http", "type" : 1, "version" : "V0.0.1", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "auth_type" : "AUTHORIZER", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "cors" : false, "trace_enabled" : true, "sampling_strategy" : "RATE", "sampling_param" : "10", "match_mode" : "NORMAL", "backend_type" : "HTTP", "remark" : "Web backend API", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "body_remark" : "", "result_normal_sample" : "", "result_failure_sample" : "", "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac", "tags" : [ "webApi" ], "roma_app_id" : "f37f5e81d9cb4424bf704ef2b0ac7600", "domain_name" : "", "id" : "5f918d104dc84480a75166ba99efff21", "status" : 1, "arrange_necessary" : 2, "register_time" : "2020-07-31T12:42:51Z", "update_time" : "2020-08-02T16:32:47.046289Z", "group_name" : "api_group_001", "group_version" : "V1", "run_env_name" : "RELEASE", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id" : "6f918d104dc84480a75166ba99efff41", "publish_time" : "2020-07-31 12:42:51", "roma_app_name" : "roma-3xfg", "ld_api_id" : "", "backend_api" : null, "api_group_info" : null, "req_params" : null } ] } ``` **状态码：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.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" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-roma/ErrorCode.html)。