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

文档中心

立即注册

导航

CreateResource

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

在指定工作区下创建代码源。

接口说明

不同类型代码源的身份验证方式不同：

Gitee/Gitlab/Github 代码源，通过 Token 进行身份验证。
Codeup 代码源，通过 Token 和 AK/SK 进行身份验证。
Gerrit 代码源，通过用户名/密码进行身份验证。
通用 Git/BitbucketCloud 代码源， Token 或用户名/密码两种方式均可。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateResource	接口名称。当前 API 的名称为 `CreateResource`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
WorkspaceId	String	是	18be9***a1aca409f5e19c**	工作区 ID。
Name	String	是	test	代码源名称。支持任意字符，长度限制为 2~50 个字符。同一工作区下名称唯一。
Description	String	否	test描述	代码源描述，支持任意字符，长度限制为 0~256 个字符。
Type	String	是	Gitee	支持的代码仓库类型。 Github：Github 代码仓库 Gitlab：Gitlab 代码仓库 Gitee：Gitee 代码仓库 Gerrit：Gerrit 代码仓库 BitbucketCloud：BitbucketCloud 代码仓库 Git：通用 Git 类型代码仓库 Codeup：Codeup代码仓库
Configuration	Object of ResourceConfiguration	是	-	代码源配置信息

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。

请求示例

POST https://open.volcengineapi.com/?Action=CreateResource&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "WorkspaceId": "000ce713ebd2487a9b4666c7ed81****",
    "Name": "Gitee-demo",
    "Description": "Gitee repo test",
    "Type": "Gitee",
    "Configuration": {
        "Git": {
            "Url": "https://gitee.com/****",
            "UserToken": "0f6832949f31ef77****"
        }
    }
}

返回参数

参数	类型	示例值	描述
Id	String	1bfc821c23594ebbb7df1ae6b636****	代码源 ID。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "2023060411042010023228002****",
        "Action": "CreateResource",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "1bfc821c23594ebbb7df1ae6b636****"
    }
}

错误码

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