调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateRoute	要执行的操作，取值：UpdateRoute。
Version	String	是	2025-10-30	API的版本，取值：2025-10-30。
ServiceName	String	是	my-vikingdb-service	服务名称 @example:my-vikingdb-service
RouteName	String	是	SearchVectors	路由名称 @example:SearchVectors
Priority	Integer	否	50	路由优先级 @example:50
PermissionPool	String	否	NewPermissionPool	权限池名称 @example:NewPermissionPool
ResourceType	String	否	Collection	资源类型 @example:Collection
AuthResourceType	String	否	Collection	鉴权资源类型 @example:Collection
Description	String	否	"更新后的路由描述"	路由描述 @example:"更新后的路由描述"
ApiSpec	Object	否	example	API规范配置
Status	String	否	Active	路由状态：Active, Inactive @example:Active

返回参数

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

参数	类型	示例值	描述
Path	String	/api/v1/collection/:collection_name/search	请求路径 @example:/api/v1/collection/:collection_name/search
Method	String	POST	HTTP方法，多个用逗号分隔 @example:POST
Status	String	active	路由状态：inactive, active, draft @example:active
ApiSpec	Object	example	API规范配置，用于提取资源标识和过滤响应
Priority	Integer	100	路由优先级，越小越优先，默认100 @example:100
CreatedAt	Long	1701504000000	创建时间（Unix时间戳毫秒） @example:1701504000000
RouteName	String	SearchVectors	路由名称，在服务内唯一 @example:SearchVectors
UpdatedAt	Long	1701504000000	更新时间（Unix时间戳毫秒） @example:1701504000000
Description	String	"向量搜索接口"	路由描述 @example:"向量搜索接口"
ResourceType	String	Collection	资源类型 @example:Collection
PathMatchType	String	EXACT	路径匹配类型 @example:EXACT
PermissionPool	String	VikingDB	权限池名称 @example:VikingDB
AuthResourceType	String	Collection	鉴权资源类型，不填则使用ResourceType @example:Collection
SourceTemplateId	String	rt_vikingdb_search_001	来源路由模板ID @example:rt_vikingdb_search_001

请求示例

POST
{
    "ServiceName": "my-vikingdb-service",
    "RouteName": "SearchVectors",
    "Priority": 50,
    "PermissionPool": "NewPermissionPool",
    "ResourceType": "Collection",
    "AuthResourceType": "Collection",
    "Description": "\"更新后的路由描述\"",
    "ApiSpec": {
        "ActionType": "READ",
        "Extractors": [
            {
                "Path": "/collection_name",
                "IsAuth": true,
                "Source": null,
                "ResourceType": "Collection"
            }
        ],
        "ActionValue": "search",
        "IdentifierType": null,
        "IdentifierValue": "/collection_name",
        "ResponseFilters": [
            {
                "Mode": null,
                "IsAuth": false,
                "IdField": "id",
                "Attributes": [
                    {
                        "Field": "/id",
                        "Target": "ResourceId"
                    }
                ],
                "FilterPath": "/data/items",
                "ResourcePath": "/data",
                "ResourceType": "Collection"
            }
        ]
    },
    "Status": "Active"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateRoute",
        "Region": "cn-north-1",
        "Service": "***",
        "Version": "2025-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "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": false,
                    "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"
    }
}

错误码

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

状态码	错误码	错误信息	说明
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

这个页面对您有帮助吗？

有用

无用

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

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码