ListResources--持续交付-火山引擎

文档中心

立即注册

导航

ListResources

最近更新时间：2024.09.27 14:46:37首次发布时间：2024.07.02 21:03:13

查询代码源列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListResources&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListResources	接口名称。当前 API 的名称为 `ListResources`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
WorkspaceId	String	是	000ce713ebd2487a9b4666c7ed81****	工作区 ID。
PageNumber	Long	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Long	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10
Filter	Object of ResourceFilter	否	-	待查询代码源列表的过滤条件。

ResourceFilter

参数	类型	是否必选	示例值	描述
Types	Array of String	否	["Github"]	待查询代码源类型。取值有： GitHub：GitHub 代码仓库 GitLab：GitLab 代码仓库 Gitee：Gitee 代码仓库 Gerrit：Gerrit 代码仓库 BitbucketCloud：BitbucketCloud 代码仓库 Git：通用 Git 类型代码仓库 Codeup：Codeup代码仓库
Name	String	否	github-demo	按代码源名称过滤，模糊查询。
Ids	Array of String	否	["1bfc821c23594ebbb7df1ae6b636****"]	按代码源 ID 过滤，精确查询。

参数

类型

是否必选

示例值

描述

Types

Array of String

否

["Github"]

待查询代码源类型。取值有：

GitHub：GitHub 代码仓库
GitLab：GitLab 代码仓库
Gitee：Gitee 代码仓库
Gerrit：Gerrit 代码仓库
BitbucketCloud：BitbucketCloud 代码仓库
Git：通用 Git 类型代码仓库
Codeup：Codeup代码仓库

Name

String

否

github-demo

按代码源名称过滤，模糊查询。

Ids

Array of String

否

["1bfc821c23594ebbb7df1ae6b636****"]

按代码源 ID 过滤，精确查询。

请求示例

POST https://open.volcengineapi.com/?Action=ListResources&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "WorkspaceId": "000ce713ebd2487a9b4666c7ed81****",
    "Filter": {
        "Types": [
            "Github"
        ],
        "Name": "github-demo",
        "Ids": [
            "1bfc821c23594ebbb7df1ae6b636****"
        ]
    }
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	10	代码源总数。
Items	Array of Resource	-	代码源列表。
PageNumber	Long	1	当前页码。
PageSize	Long	10	单页数量。

Resource

参数	类型	示例值	描述
Id	String	1bfc821c23594ebbb7df1ae6b636****	代码源 ID。
WorkspaceId	String	000ce713ebd2487a9b4666c7ed81****	工作区 ID。
Name	String	test	代码源名称。
Description	String	这是一段描述	代码源描述。
Type	String	Gitee	代码源类型。
Configuration	Object of ResourceConfiguration	-	代码源配置信息。
Creator	Object of IAMUser	{ "AccountId": 24506499****, "UserId": 0 }	代码源创建人。
CreateTime	String	2023-05-01T12:00:00+08:00	代码源创建时间。
UpdateTime	String	2023-05-01T12:02:00+08:00	代码源更新时间。

ResourceConfiguration

参数	类型	示例值	描述
Git	Object of GitConfiguration	-	代码源配置信息。

GitConfiguration

参数	类型	示例值	描述
Url	String	https://gitee.com/****	代码仓库 URL。
UserToken	String	0f6832949f31ef77****	用户 Token。
UserName	String	user	用户名。
Password	String	pwd****	密码。
CloneDepth	Long	0	代码克隆深度，默认值或最小值都为 0。
AccessKey	String	qAfR************	第三方云的 AccessKey。
SecretKey	String	Qtlc************	第三方云的 SecretKey。

IAMUser

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

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20240402200758937550AAA43B9E05****",
        "Action": "ListResources",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing",
    },
    "Result": {
        "Items": [
            {
                "Id": "1bfc821c23594ebbb7df1ae6b636****",
                "WorkspaceId": "000ce713ebd2487a9b4666c7ed81****",
                "Name": "test",
                "Type": "Gitee",
                "Configuration": {
                    "Git": {
                        "Url": "[https://gitee.com/](https://gitee.com/)****",
                        "UserToken": "0f6832949f31ef77****",
                        "CloneDepth": 0
                    }
                },
                "CreateTime": "2023-04-28T11:54:24+08:00",
                "UpdateTime": "2023-05-08T22:07:26+08:00",
                "Creator": {
                    "AccountId": 24506499****,
                    "UserId": 0
                }
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

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