查询服务连接列表

请求说明

为获得低延迟，建议您根据资源所在的地域选择对应的服务地址，详情参见服务地址。

请求方式：POST

请求地址：https://cp.cn-beijing.volcengineapi.com?Action=ListServiceConnections&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListServiceConnections	接口名称。当前 API 的名称为 ListServiceConnections。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 2023-05-01。
PageNumber	Long	否	1	当前页码。
PageSize	Long	否	10	单页数量。
Filter	Object of SCFilter	否		服务连接的过滤参数。

SCFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["svc-connect-***"]	服务连接的 ID 列表。
Name	String	否	my	服务连接的名称，支持模糊匹配。
TypeInfo	Object of FilterTypeInfo	否		服务连接的类型信息。
WorkspaceId	String	否	ws****	服务连接的共享工作区 ID。

FilterTypeInfo

参数	类型	是否必选	示例值	描述
Type	String	否	Gitlab	服务连接的类型，支持的取值如下所示。 DockerRegistry ArtifactRegistry Github Gitlab Gitee BitbucketCloud Codeup PrivateGitLab BitbucketServer Gerrit Git Perforce Codebase Coding GitCode
Category	String	否	CodeRepo	服务连接的类别： Registry：制品仓库类别。 CodeRepo：代码源类别。

请求示例

POST https://cp.cn-beijing.volcengineapi.com?Action=ListServiceConnections&Version=2023-05-01 HTTP/1.1​
Content-Type: application/json​
{​
    "PageNumber": 1,​
    "PageSize": 10,​
    "Filter": {​
        "Name": "my"​
    }​
}​

返回参数

参数	类型	示例值	描述
Total	Long	100	服务连接的总数量。
PageNumber	Long	1	当前页码。
PageSize	Long	10	单页数量。
Items	Array of ServiceConnection		服务连接列表。

ServiceConnection

参数	类型	示例值	描述
Id	String	svc-connect****	服务连接 ID。
URL	String	https://gitlab.com	服务连接的地址信息。
Name	String	my-gitlab	服务连接的地址信息。
Type	String	Gitlab	服务连接的类型，支持的取值如下所示。 DockerRegistry ArtifactRegistry Github Gitlab Gitee BitbucketCloud Codeup PrivateGitLab BitbucketServer Gerrit Git Perforce Codebase Coding GitCode
Creator	Object of IAMUser		服务连接创建人。
Category	String	CodeRepo	服务连接的类别： Registry：制品仓库类别。 CodeRepo：代码源类别。
CreateTime	String	2024-01-01T00:00:00+08:00	服务连接创建时间。
Credential	Object of CredentialConf		服务连接的凭证信息。
UpdateTime	String	2024-01-01T00:00:00+08:00	服务连接更新时间。
Description	String	我的gitlab服务	服务连接描述。
IsAllWsShared	Boolean	false	服务连接是否为所有工作空间共享。
PipelineBinding	Boolean	false	服务连接是否绑定到流水线。
SharedWorkspaceIds	Array of String	["ws-123", "ws-456"]	服务连接的共享的工作空间 ID 列表。

IAMUser

参数	类型	示例值	描述
AccountId	Long	210048****	火山引擎账号（主账号）ID。
UserId	Long	28****	子用户（IAM 用户）ID。

CredentialConf

参数	类型	示例值	描述
Token	String	glpat***	服务连接凭证。
Password	String	password***	服务连接凭证的密码。
Username	String	test-user	服务连接凭证的用户名。
AccessKey	String	AKIAIOS***	服务连接凭证的 AccessKey。
SecretKey	String	wJalrXUtnFEMINGPxRfiCY***	服务连接凭证的 SecretKey。

返回示例

HTTP/1.1 200 OK​
Content-Type: application/json​
{​
    "ResponseMetadata": {​
        "RequestId": "202509161802522086048CF4D6121C****",​
        "Action": "ListServiceConnections",​
        "Version": "2023-05-01",​
        "Service": "cp",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Total": 1,​
        "PageNumber": 1,​
        "PageSize": 10,​
        "Items": [​
            {​
                "Id": "my_svc_****",​
                "Name": "my-gitlab",​
                "Description": null,​
                "Category": "CodeRepo",​
                "Type": "Gitlab",​
                "Credential": {},​
                "IsAllWsShared": true,​
                "Creator": {​
                    "AccountId": 210048****,​
                    "UserId": ****​
                },​
                "CreateTime": "2025-09-16T17:28:57+08:00",​
                "UpdateTime": "2025-09-16T17:28:57+08:00"​
            }​
        ]​
    }​
}​

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

持续交付