Create a code source in the specified workspace.

API description

Authentication methods differ for different types of code sources:

Code sources from Gitee, Gitlab, and Github are authenticated using a Token.

The Codeup code source authenticates identities using Token and AK/SK.

Gerrit code source authenticates using username and password.

Generic Git or BitbucketCloud code source. Supports authentication using either a token or a username and password.

Request description

To achieve low latency, it is recommended that you select the corresponding service address based on the region where your resources are located. For details, see Service Address.

Request method: POST

Request URL: https://cp.cn-beijing.volcengineapi.com?Action=CreateResource&Version=2023-05-01

Request parameters

Parameter	Type	Required	Sample Value	Description
Action	String	Yes	CreateResource	The API name. The name of the current API is CreateResource.
Version	String	Yes	2023-05-01	The API version. The current version of the API is 2023-05-01.
WorkspaceId	String	Yes	18be9***a1aca409f5e19c**	The workspace ID.
Name	String	Yes	test	The code source name. Any characters are supported; the length must be between 2 and 50 characters. Names must be unique within the same workspace.
Description	String	no	Test description	The code source description supports any characters and must be between 0 and 256 characters in length.
Type	String	Yes	Gitee	Supported code repository types. The GitHub code repository Gitlab: Gitlab code repository Gitee: Gitee code repository Gerrit: Gerrit code repository BitbucketCloud: BitbucketCloud code repository General-purpose Git repository Codeup: Code repository
Configuration	Object of ResourceConfiguration	Yes	-	Code source configuration information

ResourceConfiguration

Parameter	Type	Required	Sample Value	Description
Git	Object of GitConfiguration	no	-	Configuration information for the code source

GitConfiguration

Parameter	Type	Required	Sample Value	Description
Url	String	Yes	https://gitee.com/****	Code repository URL.
UserToken	String	no	0f6832949f31ef77****	User token
UserName	String	no	user	Username.
Password	String	no	pwd****	Password.
CloneDepth	Long	no	0	Code clone depth. The default and minimum values are both 0.
AccessKey	String	no	qAfR************	Third-party cloud AccessKey.
SecretKey	String	no	Qtlc************	The SecretKey of the third-party cloud.

Sample requests

Response parameters

Parameter	Type	Sample Value	Description
Id	String	1bfc821c23594ebbb7df1ae6b636****	Code source ID

Sample response

Error code

This API currently does not have independent error codes. If the API call returns an error, refer to the public error codes for troubleshooting.

Code Pipeline