获取路由模板选项列表
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DescribeRouteTemplateOptions | 要执行的操作,取值:DescribeRouteTemplateOptions。 |
Version | String | 是 | 2025-10-30 | API的版本,取值:2025-10-30。 |
TemplateId | String | 是 | tpl_vikingdb_001 | 服务模板ID @example:tpl_vikingdb_001 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Routes | Array of Object | example | 路由模板选项列表 |
Template | Object | example | 模板基本信息 |
POST { "TemplateId": "tpl_vikingdb_001" }
{ "ResponseMetadata": { "Action": "DescribeRouteTemplateOptions", "Region": "cn-north-1", "Service": "***", "Version": "2025-10-30", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Routes": [ { "Path": "/api/v1/search", "Method": "POST", "RouteName": "SearchVectors", "SortOrder": 1, "Description": "\"向量搜索接口\"", "RouteTemplateId": "rt_vikingdb_search_001" } ], "Template": { "IconUrl": "https://cdn.example.com/icons/vikingdb.png", "Protocol": "HTTPS", "EnableTls": true, "RouteCount": 5, "TemplateId": "tpl_vikingdb_001", "BackendPort": 443, "Description": "\"VikingDB 向量数据库服务\"", "TemplateName": "VikingDB", "BackendDomain": "vikingdb.volces.com" } } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | InvalidParameter | 参数 %s 无效 |
404 | NotFound | 资源 %s 不存在 |
409 | Duplicated | 资源 %s 已存在 |
409 | StatusConflict | 状态冲突: %s |
422 | ParseFailed | 文档解析失败: %s |
429 | QuotaExceeded | 配额 %s 已达上限 |
500 | InternalError | 内部服务错误: %s |
501 | NotImplemented | 功能未实现: %s |
502 | UpstreamUnreachable | 后端服务 %s 不可达 |