Updated on 2026-01-22 GMT+08:00

Editing a Repository

Function

This API is used to edit a repository.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsartifact:repository:edit

Write

-

-

-

-

URI

PUT /cloudartifact/v5/repositories/tab/{tab_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

tab_id

Yes

String

Definition:

tab_id, ID of a pair of Maven repositories (release and snapshot).

Constraints

N/A.

Range

N/A.

Default value

N/A.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

repo_name

Yes

String

Definition

Repository name.

Constraints

String length: 1–20 characters.

Range

N/A.

Default value

None

includes_pattern

Yes

String

Definition

Include Patterns.

Constraints

Maximum length: 512 characters.

Range

N/A.

Default value

None

project_id

No

String

Definition

Project ID, which 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 contains 32 characters. Only letters and digits are supported.

Range

N/A.

Default value

None

description

No

String

Definition

Repository description.

Constraints

Maximum length: 200 characters.

Range

N/A.

Default value

None

snapshot

No

String

Definition

Snapshot repository name.

Constraints

String length: 1–20 characters.

Range

N/A.

Default value

None

release

No

String

Definition

Release repository name.

Constraints

String length: 1–20 characters.

Range

N/A.

Default value

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition

Request status.

Range

success: The request is successful.

error: The request fails.

trace_id

String

Definition

Request ID, which uniquely identifies the current request.

Range

A string of digits and hyphens (-).

result

MavenTabRepo object

Definition

Repository information.

Range

N/A.

Table 4 MavenTabRepo

Parameter

Type

Description

release

String

Definition

Release repository name.

Range

N/A.

snapshot

String

Definition

Snapshot repository name.

Range

N/A.

Example Requests

This API is used to edit a Maven repository.

https://artifact.example-1.myhuaweicloud.com/cloudartifact/v5/repositories/tab/{tab_id}

{
  "repo_name" : "testmaven",
  "description" : "12",
  "includes_pattern" : "**/*",
  "release" : "testmaven",
  "snapshot" : "testmaven"
}

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "trace_id" : "143002-1701175397265-80",
  "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

This API is used to edit 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
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 ModifyRepositorySolution {

    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();
        ModifyRepositoryRequest request = new ModifyRepositoryRequest();
        request.withTabId("{tab_id}");
        IDERepositoryPair body = new IDERepositoryPair();
        body.withRelease("testmaven");
        body.withSnapshot("testmaven");
        body.withDescription("12");
        body.withIncludesPattern("**/*");
        body.withRepoName("testmaven");
        request.withBody(body);
        try {
            ModifyRepositoryResponse response = client.modifyRepository(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

This API is used to edit 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
# 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 = ModifyRepositoryRequest()
        request.tab_id = "{tab_id}"
        request.body = IDERepositoryPair(
            release="testmaven",
            snapshot="testmaven",
            description="12",
            includes_pattern="**/*",
            repo_name="testmaven"
        )
        response = client.modify_repository(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

This API is used to edit 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
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.ModifyRepositoryRequest{}
	request.TabId = "{tab_id}"
	releaseIdeRepositoryPair:= "testmaven"
	snapshotIdeRepositoryPair:= "testmaven"
	descriptionIdeRepositoryPair:= "12"
	request.Body = &model.IdeRepositoryPair{
		Release: &releaseIdeRepositoryPair,
		Snapshot: &snapshotIdeRepositoryPair,
		Description: &descriptionIdeRepositoryPair,
		IncludesPattern: "**/*",
		RepoName: "testmaven",
	}
	response, err := client.ModifyRepository(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.