Updated on 2025-09-08 GMT+08:00

Creating a Maven Repository

Function

Create a Maven repository.

Calling Method

For details, see Calling APIs.

URI

POST /cloudartifact/v5/maven/repositories

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

repository_name

Yes

String

Definition:

Repository name.

Constraints:

A string of 1 to 50 characters.

Value range:

N/A

Default value:

None

format

Yes

String

Definition:

Package type.

Constraints:

N/A

Value range:

maven2.

Default value:

None

description

No

String

Definition:

Repository description.

Constraints:

Maximum length: 200 characters.

Value range:

N/A

Default value:

None

release

No

String

Definition:

Release repository name.

Constraints:

A string of 1 to 50 characters.

Value range:

N/A

Default value:

None

snapshot

No

String

Definition:

Snapshot repository name.

Constraints:

A string of 1 to 50 characters.

Value range:

N/A

Default value:

None

includes_pattern

No

String

Definition:

Include patterns.

Constraints:

Maximum length: 512 characters.

Value range:

N/A

Default value:

None

share_right

No

String

Definition:

Shared permission.

Constraints:

N/A

Value range:

PROJECT

Default value:

None

project_id

No

String

Definition:

Project ID. It can be obtained by calling an API or from the console. For details about how to obtain the project ID, see Obtaining a Project ID (CloudArtifact_api_0015.xml).

Constraints:

The value can contain 32 characters. Only letters and digits are supported.

Value range:

N/A

Default value:

None

type

Yes

String

Definition:

Repository type.

Constraints:

N/A

Value range:

hosted: local repository

Default value:

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition:

Request status.

Value range:

success: The request is successful.

error: The request fails.

trace_id

String

Definition:

Request ID, which uniquely identifies the current request.

Value range:

A string of digits and hyphens (-).

result

CreateMavenRepoResult object

Definition:

Information about the created Maven repository.

Value range:

N/A

Table 3 CreateMavenRepoResult

Parameter

Type

Description

release

String

Definition:

ID of the release repository.

Value range:

N/A

snapshot

String

Definition:

Id of the snapshot repository.

Value range:

N/A

Example Requests

Creating a Maven Repository

https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/maven/repositories

{
  "repository_name" : "testmaven",
  "format" : "maven2",
  "description" : "",
  "release" : "testmaven",
  "snapshot" : "testmaven",
  "includes_pattern" : "**/*",
  "share_right" : "PROJECT",
  "project_id" : "e2ee90487d6349dd944a5767225f6f55",
  "type" : "hosted"
}

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "trace_id" : "143002-1701175135227-77",
  "result" : {
    "release" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_201",
    "snapshot" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_2_201"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Java

Creating a Maven Repository

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartsartifact.v2.region.CodeArtsArtifactRegion;
import com.huaweicloud.sdk.codeartsartifact.v2.*;
import com.huaweicloud.sdk.codeartsartifact.v2.model.*;


public class CreateMavenRepoSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsArtifactClient client = CodeArtsArtifactClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsArtifactRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateMavenRepoRequest request = new CreateMavenRepoRequest();
        IDERepositoryDO body = new IDERepositoryDO();
        body.withType("hosted");
        body.withProjectId("e2ee90487d6349dd944a5767225f6f55");
        body.withShareRight("PROJECT");
        body.withIncludesPattern("**/*");
        body.withSnapshot("testmaven");
        body.withRelease("testmaven");
        body.withDescription("");
        body.withFormat("maven2");
        body.withRepositoryName("testmaven");
        request.withBody(body);
        try {
            CreateMavenRepoResponse response = client.createMavenRepo(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

Creating a Maven Repository

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsartifact.v2.region.codeartsartifact_region import CodeArtsArtifactRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsartifact.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsArtifactClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsArtifactRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateMavenRepoRequest()
        request.body = IDERepositoryDO(
            type="hosted",
            project_id="e2ee90487d6349dd944a5767225f6f55",
            share_right="PROJECT",
            includes_pattern="**/*",
            snapshot="testmaven",
            release="testmaven",
            description="",
            format="maven2",
            repository_name="testmaven"
        )
        response = client.create_maven_repo(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Creating a Maven Repository

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsartifact "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartsartifact.NewCodeArtsArtifactClient(
        codeartsartifact.CodeArtsArtifactClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateMavenRepoRequest{}
	typeIdeRepositoryDo:= "hosted"
	projectIdIdeRepositoryDo:= "e2ee90487d6349dd944a5767225f6f55"
	shareRightIdeRepositoryDo:= "PROJECT"
	includesPatternIdeRepositoryDo:= "**/*"
	snapshotIdeRepositoryDo:= "testmaven"
	releaseIdeRepositoryDo:= "testmaven"
	descriptionIdeRepositoryDo:= ""
	formatIdeRepositoryDo:= "maven2"
	repositoryNameIdeRepositoryDo:= "testmaven"
	request.Body = &model.IdeRepositoryDo{
		Type: &typeIdeRepositoryDo,
		ProjectId: &projectIdIdeRepositoryDo,
		ShareRight: &shareRightIdeRepositoryDo,
		IncludesPattern: &includesPatternIdeRepositoryDo,
		Snapshot: &snapshotIdeRepositoryDo,
		Release: &releaseIdeRepositoryDo,
		Description: &descriptionIdeRepositoryDo,
		Format: &formatIdeRepositoryDo,
		RepositoryName: &repositoryNameIdeRepositoryDo,
	}
	response, err := client.CreateMavenRepo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.