调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListServices	要执行的操作，取值：ListServices。
Version	String	是	2025-10-30	API的版本，取值：2025-10-30。
Keyword	String	否	vikingdb	关键词搜索 @example:vikingdb
BackendType	String	否	viking	后端类型过滤：custom, viking, agentkit-mcp @example:viking
TemplateKeyword	String	否	vikingdb	模板关键词搜索 @example:vikingdb
Status	String	否	active	状态过滤：active, inactive @example:active
PermissionSpaceId	String	否	ps_123456	权限空间ID过滤 @example:ps_123456
SortBy	String	否	CreatedAt	排序字段：CreatedAt, UpdatedAt, ServiceName @example:CreatedAt
SortOrder	String	否	Desc	排序方向：Asc, Desc @example:Desc
PageNumber	Integer	否	1	页码，从1开始 @example:1
PageSize	Integer	否	10	每页条数，默认10，最大100 @example:10
TagIds	Array of String	否	["tag_ai_001"]	标签ID过滤 @example:["tag_ai_001"]
ProjectName	String	否	default	项目名称过滤 @example:default
TagFilters	Array of Object	否	[{"Key": "tag1", "Values": ["value1", "value2"]}]	标签过滤 @example:[{"Key": "tag1", "Values": ["value1", "value2"]}]

返回参数

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

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

请求示例

POST
{
    "Keyword": "vikingdb",
    "BackendType": "Builtin",
    "TemplateKeyword": "vikingdb",
    "Status": "Active",
    "PermissionSpaceId": "ps_123456",
    "SortBy": "CreatedAt",
    "SortOrder": "Desc",
    "PageNumber": 1,
    "PageSize": 10,
    "TagIds": [
        "tag_ai_001"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListServices",
        "Region": "cn-north-1",
        "Service": "***",
        "Version": "2025-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Items": [
            {
                "Status": null,
                "Backend": {
                    "Protocol": "HTTPS",
                    "EnableTls": true,
                    "BackendPort": 443,
                    "BackendDomain": "api.example.com",
                    "TimeoutSeconds": 30
                },
                "CreatedAt": 1701504000000,
                "ServiceId": "svc-1234567890",
                "UpdatedAt": 1701504000000,
                "RouteCount": 5,
                "TemplateId": "tpl_vikingdb_001",
                "BackendType": null,
                "Description": "\"用于VikingDB向量搜索的权限网关\"",
                "ServiceName": "my-vikingdb-service",
                "PermissionSpaceId": "ps_123456",
                "HijackDomainPublic": "api.example.com",
                "HijackDomainPrivate": "api.example.com",
                "PermissionSpaceName": "\"我的权限空间\""
            }
        ],
        "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

这个页面对您有帮助吗？

有用

无用

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

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码