调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListRoutes	要执行的操作，取值：ListRoutes。
Version	String	是	2025-10-30	API的版本，取值：2025-10-30。
ServiceName	String	是	my-vikingdb-service	服务名称 @example:my-vikingdb-service
Keyword	String	否	search	关键词搜索 @example:search
Method	String	否	POST	HTTP方法过滤 @example:POST
Status	String	否	Active	状态过滤：Active, Inactive @example:Active
SortBy	String	否	Priority	排序字段：CreatedAt, UpdatedAt, RouteName, Priority @example:Priority
SortOrder	String	否	Asc	排序方向：Asc, Desc @example:Asc
PageNumber	Integer	否	1	页码，从1开始 @example:1
PageSize	Integer	否	10	每页条数，默认10，最大100 @example:10

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Items	Array of Object	example	路由列表
PageInfo	Object	example	分页信息

请求示例

POST
{
    "ServiceName": "my-vikingdb-service",
    "Keyword": "search",
    "Method": "POST",
    "Status": "Active",
    "SortBy": "Priority",
    "SortOrder": "Asc",
    "PageNumber": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListRoutes",
        "Region": "cn-north-1",
        "Service": "***",
        "Version": "2025-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Items": [
            {
                "Path": "/api/v1/collection/:collection_name/search",
                "Method": "POST",
                "Status": null,
                "ApiSpec": {
                    "ActionType": "READ",
                    "Extractors": [
                        {
                            "Path": "/collection_name",
                            "IsAuth": false,
                            "Source": null,
                            "ResourceType": "Collection"
                        }
                    ],
                    "ActionValue": "search",
                    "IdentifierType": null,
                    "IdentifierValue": "/collection_name",
                    "ResponseFilters": [
                        {
                            "Mode": null,
                            "IsAuth": true,
                            "IdField": "id",
                            "Attributes": [
                                {
                                    "Field": "/id",
                                    "Target": "ResourceId"
                                }
                            ],
                            "FilterPath": "/data/items",
                            "ResourcePath": "/data",
                            "ResourceType": "Collection"
                        }
                    ]
                },
                "Priority": 100,
                "CreatedAt": 1701504000000,
                "RouteName": "SearchVectors",
                "UpdatedAt": 1701504000000,
                "Description": "\"向量搜索接口\"",
                "ResourceType": "Collection",
                "PathMatchType": "EXACT",
                "PermissionPool": "VikingDB",
                "AuthResourceType": "Collection",
                "SourceTemplateId": "rt_vikingdb_search_001"
            }
        ],
        "PageInfo": {
            "PageSize": 10,
            "PageNumber": 1,
            "TotalCount": 100
        }
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	Invalid request parameters: %s.	参数 %s 无效
404	NotFound	Resource not found: %s.	资源 %s 不存在
409	Duplicated	Resource already exists: %s.	资源 %s 已存在
409	StatusConflict	Status conflict: %s.	状态冲突: %s
422	ParseFailed	Failed to parse document: %s.	文档解析失败: %s
429	QuotaExceeded	Quota exceeded: %s.	配额 %s 已达上限
500	InternalError	Internal server error: %s.	内部服务错误: %s
501	NotImplemented	Not implemented: %s.	功能未实现: %s
502	UpstreamUnreachable	Upstream unreachable: %s.	后端服务 %s 不可达

最近更新时间：2025.12.14 13:43:21

这个页面对您有帮助吗？

有用

无用

智能体身份和权限管理平台

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码