Querying the Maven Repository List and Account Password of a Tenant
Function
Query the Maven repository list and account password of a tenant. Cross-tenant Maven repository list and account password are supported.
Calling Method
For details, see Calling APIs.
URI
GET /cloudartifact/v5/maven/info
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 |
policy |
No |
String |
Definition: Repository type. The options are snapshot or release. Constraints: N/A Value range: snapshot and release 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. |
default |
No |
String |
Definition: Whether to return the default repository. Constraints: N/A Value range: true and false. Default value: false |
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 |
Request Parameters
None
Response Parameters
Status code: 200
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 |
Array of RepositoryBuildVO objects |
Definition: Maven repository list. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
username |
String |
Definition: Account. Value range: N/A |
password |
String |
Definition: Password. Value range: N/A |
status |
String |
Definition: Repository status. Value range: active: Normal. delete: Deleted. disabled: Invalid. view: Viewer of self-hosted repos. trash: Deprecated. |
domainId |
String |
Definition: Tenant ID. Value range: N/A |
region |
String |
Definition: Region. Value range: N/A |
createdTime |
String |
Definition: Creation time, in yyyy-MM-dd HH:mm:ss format. Value range: N/A |
modifiedTime |
String |
Definition: Modification time, in yyyy-MM-dd HH:mm:ss format. Value range: N/A |
createdUserId |
String |
Definition: Creator ID. Value range: N/A |
createdUserName |
String |
Definition: Creator name. Value range: N/A |
modifiedUserId |
String |
Definition: Modifier ID. Value range: N/A |
modifiedUserName |
String |
Definition: Modifier name. Value range: N/A |
name |
String |
Definition: Repository ID. Value range: N/A |
disable |
Boolean |
Definition: Disabled or not. Value range: N/A |
format |
String |
Definition: Package type. Value range: maven, maven2, npm, go, pypi, rpm, composer, debian, conan, nuget, docker2, cocoapods, ohpm, generic, helm, conda, and huggingfaceml. |
type |
String |
Definition: Repository type. Value range: hosted: local repository remote: proxy repository virtual: virtual repository |
policy |
String |
Definition: Repository policies. Value range: release or snapshot |
tabId |
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. Value range: N/A |
repositoryName |
String |
Definition: Repository name. Value range: N/A |
displayName |
String |
Definition: Repository name displayed. Value range: N/A |
description |
String |
Definition: Repository description. Value range: N/A |
snapshot |
String |
Definition: Snapshot repository name. Either Release or Snapshot or both must be selected. Value range: N/A |
release |
String |
Definition: Release repository name. Either Release or Snapshot or both must be selected. Value range: N/A |
npm |
String |
Definition: npm. Value range: N/A |
snapshotStatus |
String |
Definition: Snapshot repository status. Value range: N/A |
releaseStatus |
String |
Definition: Release repository status. Value range: N/A |
projectId |
String |
Definition: Project ID. Value range: N/A |
includesPattern |
String |
Definition: Include patterns. Value range: N/A |
repositoryIds |
Array of strings |
Definition: Repository ID list. Value range: N/A |
uri |
String |
Definition: URI. Value range: N/A |
deploymentPolicy |
String |
Definition: Deployment policies. Value range: N/A |
repositories |
Array of strings |
Definition: Repository list. Value range: N/A |
parentRepoName |
String |
Definition: Parent repository name. Value range: N/A |
userName |
String |
Definition: Username. Value range: N/A |
remoteUrl |
String |
Definition: Proxy repository address. Value range: N/A |
defaultDeployRepository |
String |
Definition: Default repository. Value range: N/A |
remoteType |
String |
Definition: Proxy repository type. Value range: public: public proxy repository customize: custom proxy repository |
proxy |
String |
Definition: Proxy. Value range: N/A |
allowAnonymous |
Boolean |
Definition: Anonymous download allowed or not. Value range: N/A |
autoCleanSnapshot |
Boolean |
Definition: Automatic snapshot version clearing enabled or not. Value range: N/A |
snapshotAliveDays |
String |
Definition: Validity period of a snapshot version, in days. Value range: N/A |
maxUniqueSnapshots |
String |
Definition: Max. number of snapshots. Value range: N/A |
shareRight |
String |
Definition: Shared permission. Value range: PROJECT |
nexuRepo |
Boolean |
Definition: Nexus repository or not. Value range: N/A |
url |
String |
Definition: Repository URL. Value range: N/A |
packageType |
String |
Definition: Package type. Value range: maven, maven2, npm, go, pypi, rpm, composer, debian, conan, nuget, docker2, cocoapods, ohpm, generic, helm, conda, and huggingfaceml. |
Example Requests
Query the Maven repository list and account password of a tenant.
https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/maven/info?project_id=e2ee90487d6349dd944a5767225f6f55&policy=release&access=r&default=false
Example Responses
Status code: 200
OK
{ "status" : "success", "trace_id" : "143002-1701176094147-90", "result" : [ { "status" : "active", "domainId" : "5a775fdcb14f4431b6c0015618140bc3", "region" : "xx-xxxxx-x", "createdTime" : "2023-11-24 17:13:52", "modifiedTime" : "2023-11-24 17:13:52", "createdUserId" : "e9253deb37654775bb3c411aca89153a", "createdUserName" : "devcloud_devcloud_y00226182_01", "modifiedUserId" : null, "modifiedUserName" : null, "name" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_5_120", "disable" : false, "format" : "maven2", "type" : "virtual", "policy" : "release", "tabId" : "5a775fdcb14f4431b6c0015618140bc3_tab_maven2_120", "repositoryName" : "adasasfsafdasdfasd", "displayName" : "adasasfsafdasdfasd", "description" : "", "snapshot" : null, "release" : null, "npm" : null, "snapshotStatus" : null, "releaseStatus" : null, "projectId" : "e2ee90487d6349dd944a5767225f6f55", "includesPattern" : "**/*", "repositoryIds" : null, "uri" : null, "deploymentPolicy" : null, "repositories" : null, "parentRepoName" : null, "userName" : null, "password" : "***", "remoteUrl" : null, "defaultDeployRepository" : null, "remoteType" : null, "proxy" : null, "allowAnonymous" : null, "autoCleanSnapshot" : null, "snapshotAliveDays" : null, "maxUniqueSnapshots" : null, "shareRight" : "PROJECT", "nexuRepo" : false, "username" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_e9253deb37654775bb3c411aca89153a", "url" : "https://devrepo.devcloud.xx-xxxxx-x.xxxxxxx.huawei.com/artgalaxy/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_5_120/", "packageType" : "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 ShowMavenInfoSolution { 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(); ShowMavenInfoRequest request = new ShowMavenInfoRequest(); try { ShowMavenInfoResponse response = client.showMavenInfo(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 = ShowMavenInfoRequest() response = client.show_maven_info(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.ShowMavenInfoRequest{} response, err := client.ShowMavenInfo(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