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

文档中心

立即注册

导航

持续交付

UpdateResource

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

更新代码源。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateResource	接口名称。当前 API 的名称为 `UpdateResource`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
WorkspaceId	String	是	000ce713ebd2487a9b4666c7ed81****	工作区 ID。
Id	String	是	1bfc821c23594ebbb7df1ae6b636****	代码源 ID。
Name	String	否	Gitee-demo-new	代码源名称。支持任意字符，长度限制为 2~50 个字符。同一工作区下，名称唯一。
Configuration	Object of ResourceConfiguration	否	-	代码源配置信息
Description	String	否	这是一段描述	代码源描述。

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=UpdateResource&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "WorkspaceId": "000ce713ebd2487a9b4666c7ed81****",
    "Id": "1bfc821c23594ebbb7df1ae6b636****",
    "Name": "Gitee-demo-new",
    "Description": "this is a test",
    "Configuration": {
        "Git": {
            "Url": "https://gitee.com/****",
            "UserToken": "0f6832949f31ef77****"
        }
    }
}

返回参数

本接口无特有的返回参数。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "2024040318000935E3789440C7C089****",
        "Action": "UpdateResource",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing",
    },
    "Result": {}
}

错误码

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