Querying Maven Repositories
Function
Query Maven repositories.
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:list |
List |
- |
- |
- |
- |
URI
GET /cloudartifact/v5/maven/list
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
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 |
|
default |
No |
Boolean |
Definition: Whether to return the default repository. Constraints: N/A Value range: true and false. Default value: false |
|
policy |
No |
String |
Definition: Repository type. The options are snapshot or release. Constraints: N/A Value range: snapshot and release Default value: N/A |
|
repo_ids |
No |
String |
Definition: Repository IDs. Use commas (,) to separate multiple repository IDs. The repository ID is in the format of {region}{domainId}{format}_{sequence}. You can find the repository ID on the general page of your self-hosted repos. It is the string located between the last two slashes (/) in the repository URL. Constraints: N/A Value range: Maximum length: 512 characters. Default value: N/A |
|
access |
No |
String |
Definition: Permission filtering setting, which allows read (r) and read-write (rw) permissions. Constraints: N/A Value range: r and rw. Default value: r. |
Request Parameters
None
Response Parameters
Status code: 200
|
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 |
Array of RepositoryDOV5 objects |
Definition Repository list. Range N/A. |
|
Parameter |
Type |
Description |
|---|---|---|
|
status |
String |
Definition Repository status. Range active: Normal. delete: Deleted. disabled: Invalid. view: Viewer of self-hosted repos. trash: Deprecated. |
|
domain_id |
String |
Definition Tenant ID. Range N/A. |
|
region |
String |
Definition Area. Range N/A. |
|
created_time |
String |
Definition Creation time, in yyyy-MM-dd HH:mm:ss format. Range N/A. |
|
modified_time |
String |
Definition Modification time, in yyyy-MM-dd HH:mm:ss format. Range N/A. |
|
created_user_id |
String |
Definition Creator ID. Range N/A. |
|
created_user_name |
String |
Definition Creator. Range N/A. |
|
modified_user_id |
String |
Definition Modifier ID. Range N/A. |
|
modified_user_name |
String |
Definition Modifier. Range N/A. |
|
repository_name |
String |
Definition Repository name. Range N/A. |
|
format |
String |
Definition Package type. Range maven, maven2, npm, go, pypi, rpm, composer, debian, conan, nuget, docker2, cocoapods, ohpm, generic, helm, and conda. |
|
type |
String |
Definition Repository type. Range hosted: local repository remote: proxy repository virtual: virtual repository |
|
description |
String |
Definition Repository description. Range N/A. |
|
release |
String |
Definition Release repository name. Either Release or Snapshot or both must be selected. Range N/A. |
|
snapshot |
String |
Definition Snapshot repository name. Either Release or Snapshot or both must be selected. Range N/A. |
|
includes_pattern |
String |
Definition Include Patterns. Range N/A. |
|
excludes_pattern |
String |
Definition Exclude Patterns. Range N/A. |
|
share_right |
String |
Definition Shared permissions. Range PROJECT |
|
project_id |
String |
Definition Project ID. Range N/A. |
|
name |
String |
Definition Repository ID. Range N/A. |
|
disable |
Boolean |
Definition Disabled or not. Range N/A. |
|
policy |
String |
Definition Repository policies. Range release or snapshot |
|
npm |
String |
Definition npm. Range N/A. |
|
uri |
String |
Definition URI. Range N/A. |
|
repositories |
String |
Definition repositories. Range N/A. |
|
user_name |
String |
Definition Account. Range N/A. |
|
password |
String |
Definition Password. Range N/A. |
|
proxy |
String |
Definition Proxy. Range N/A. |
|
scope |
Integer |
Definition Range. Range N/A. |
|
url |
String |
Definition Address. Range N/A. |
|
tab_id |
String |
Definition tab_id is used to identify a pair of Maven repositories (Release and Snapshot). A tab_id indicates a pair of Maven repositories. Range N/A. |
|
display_name |
String |
Definition Repository name displayed. Range N/A. |
|
snapshot_status |
String |
Definition Snapshot repository status. Range N/A. |
|
release_status |
String |
Definition Release repository status. Range N/A. |
|
repository_ids |
String |
Definition Repository ID list. Range N/A. |
|
deployment_policy |
String |
Definition Deployment policies. Range N/A. |
|
parent_repo_name |
String |
Definition Parent repository name. Range N/A. |
|
remote_url |
String |
Definition Proxy repository address. Range N/A. |
|
remote_auth |
String |
Definition Proxy repository authentication. Range N/A. |
|
pypi_registry_url |
String |
Definition PyPI index proxy address. Range N/A. |
|
default_deploy_repository |
String |
Definition Default virtual repository. Range N/A. |
|
package_type |
String |
Definition Package type. Range N/A. |
|
nexu_repo |
Boolean |
Definition Nexus repository or not. Range N/A. |
|
migrate_flag |
Integer |
Definition Migration flag. Range N/A. |
Example Requests
Query Maven repositories.
https://{URL}/cloudartifact/v5/maven/list?project_id=e43d0c28dca0439b9d8651224ca30ccc&policy=release&access=r&repo_ids=xx-xxxxx-x_09d2ca2f5080d5b60f51c00ae5bad0a0_maven_1_100
Example Responses
Status code: 200
OK
{
"status" : "success",
"trace_id" : "ddfa39b9d5d34baa82b23a5b73faf15c",
"result" : [ {
"status" : "active",
"region" : "xx-xxxxx-x",
"name" : "xx-xxxxx-x_09d2ca2f5080d5b60f51c00ae5bad0a0_maven_1_100",
"disable" : false,
"format" : "maven2",
"type" : "hosted",
"policy" : "release",
"description" : "",
"snapshot" : null,
"release" : null,
"npm" : null,
"uri" : null,
"repositories" : null,
"password" : null,
"proxy" : null,
"url" : "https://devrepo.devcloud.xx-xxxxx-x.huawei.com/artgalaxy/xx-xxxxx-x_09d2ca2f5080d5b60f51c00ae5bad0a0_maven_1_100/",
"domain_id" : "09d2ca2f5080d5b60f51c00ae5bad0a0",
"created_time" : "2023-09-22 16:33:00",
"modified_time" : "2024-04-01 10:50:52",
"created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
"created_user_name" : "devcloud_devcloud_y00226182_05",
"modified_user_id" : null,
"modified_user_name" : null,
"tab_id" : "09d2ca2f5080d5b60f51c00ae5bad0a0_tab_maven2_100",
"repository_name" : "tttasda",
"display_name" : "tttasda",
"snapshot_status" : null,
"release_status" : null,
"project_id" : "e43d0c28dca0439b9d8651224ca30ccc",
"includes_pattern" : "**/*",
"excludes_pattern" : null,
"repository_ids" : null,
"deployment_policy" : null,
"parent_repo_name" : null,
"user_name" : null,
"remote_url" : null,
"pypi_registry_url" : null,
"default_deploy_repository" : null,
"remote_type" : null,
"allow_anonymous" : null,
"auto_clean_snapshot" : null,
"snapshot_alive_days" : null,
"max_unique_snapshots" : null,
"share_right" : "PROJECT",
"nexu_repo" : false,
"migrate_flag" : 0,
"obs_speed_bucket" : null,
"associate_project" : null,
"package_type" : "maven"
} ]
}
SDK Sample Code
The SDK sample code is as follows.
Java
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 |
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 ListMavenListSolution { 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(); ListMavenListRequest request = new ListMavenListRequest(); try { ListMavenListResponse response = client.listMavenList(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
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 |
# 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 = ListMavenListRequest() response = client.list_maven_list(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
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 |
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.ListMavenListRequest{} response, err := client.ListMavenList(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot