Help Center/ CodeArts Artifact/ API Reference/ API/ Repository Management/ Obtaining Proxy Repositories in a Virtual Repository

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

Online Debugging

CLI Examples

View PDF

Obtaining Proxy Repositories in a Virtual Repository

Function

Obtain proxy repositories in a virtual repository.

Calling Method

For details, see Calling APIs.

URI

GET /cloudartifact/v5/repositories/proxy

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
repo_id	Yes	String	Definition: Repository ID. The format is {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: The region and domainId in the repository ID must be valid values. The valid values of format are npm, go, pypi, rpm, composer, maven, debian, conan, nuget, docker2, cocoapods, and ohpm. The upper limit of sequence varies depending on the package. Default value: N/A
type	No	String	Definition: type. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

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	Array of RepositoryDOV5 objects	Definition: Repository list. Value range: N/A

**Table 3** RepositoryDOV5
Parameter	Type	Description
status	String	Definition: Repository status. Value range: active: Normal. delete: Deleted. disabled: Invalid. view: Viewer of self-hosted repos. trash: Deprecated.
domain_id	String	Definition: Tenant ID. Value range: N/A
region	String	Definition: Region. Value range: N/A
created_time	String	Definition: Creation time, in yyyy-MM-dd HH:mm:ss format. Value range: N/A
modified_time	String	Definition: Modification time, in yyyy-MM-dd HH:mm:ss format. Value range: N/A
created_user_id	String	Definition: Creator ID. Value range: N/A
created_user_name	String	Definition: Creator. Value range: N/A
modified_user_id	String	Definition: Modifier ID. Value range: N/A
modified_user_name	String	Definition: Modifier. Value range: N/A
repository_name	String	Definition: Repository name. 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
description	String	Definition: Repository description. Value range: N/A
release	String	Definition: Release repository name. Either Release or Snapshot or both must be selected. Value range: N/A
snapshot	String	Definition: Snapshot repository name. Either Release or Snapshot or both must be selected. Value range: N/A
includes_pattern	String	Definition: Include patterns. Value range: N/A
excludes_pattern	String	Definition: Exclude patterns. Value range: N/A
share_right	String	Definition: Shared permission. Value range: PROJECT
project_id	String	Definition: Project ID. Value range: N/A
name	String	Definition: Repository ID. Value range: N/A
disable	Boolean	Definition: Disabled or not. Value range: N/A
policy	String	Definition: Repository policies. Value range: release or snapshot
npm	String	Definition: npm. Value range: N/A
uri	String	Definition: URI. Value range: N/A
repositories	String	Definition: repositories. Value range: N/A
user_name	String	Definition: Account. Value range: N/A
password	String	Definition: Password. Value range: N/A
proxy	String	Definition: Proxy. Value range: N/A
scope	Integer	Definition: Range. Value range: N/A
url	String	Definition: Address. Value 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. Value range: N/A
display_name	String	Definition: Repository name displayed. Value range: N/A
snapshot_status	String	Definition: Snapshot repository status. Value range: N/A
release_status	String	Definition: Release repository status. Value range: N/A
repository_ids	String	Definition: Repository ID list. Value range: N/A
deployment_policy	String	Definition: Deployment policies. Value range: N/A
parent_repo_name	String	Definition: Parent repository name. Value range: N/A
remote_url	String	Definition: Proxy repository address. Value range: N/A
remote_auth	String	Definition: Proxy repository authentication. Value range: N/A
pypi_registry_url	String	Definition: PyPI index proxy address. Value range: N/A
default_deploy_repository	String	Definition: Default virtual repository. Value range: N/A
package_type	String	Definition: Package type. Value range: N/A
nexu_repo	Boolean	Definition: Nexus repository or not. Value range: N/A
migrate_flag	Integer	Definition: Migration flag. Value range: N/A

Example Requests

Obtain proxy repositories in a virtual repository.

https://{URL}/cloudartifact/v5/repositories/proxy?repo_id=xx-xxxxx-x_09d2ca2f5080d5b60f51c00ae5bad0a0_maven_1_100

Example Responses

Status code: 200

{
  "status" : "success",
  "trace_id" : "06db53adc97444189bcf240f2075f449",
  "result" : [ {
    "status" : "active",
    "region" : "xx-xxxxx-x",
    "name" : "xx-xxxxx-x_ef7f2157208144128212a124ac37247b_remote",
    "disable" : false,
    "format" : "maven2",
    "type" : "remote",
    "policy" : null,
    "description" : null,
    "snapshot" : null,
    "release" : null,
    "npm" : null,
    "uri" : null,
    "repositories" : null,
    "password" : null,
    "proxy" : null,
    "url" : "https://devrepo.devcloud.xx-xxxxx-x.xxxxxxx.huawei.com/artgalaxy/xx-xxxxx-x_ef7f2157208144128212a124ac37247b_remote/",
    "domain_id" : "09d2ca2f5080d5b60f51c00ae5bad0a0",
    "created_time" : "2025-02-27 11:19:38",
    "modified_time" : "2025-02-27 12:00:01",
    "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
    "created_user_name" : "devcloud_devcloud_y00226182_05",
    "modified_user_id" : null,
    "modified_user_name" : null,
    "tab_id" : null,
    "repository_name" : "testMavenProxy0227_9",
    "display_name" : "testMavenProxy0227_9",
    "snapshot_status" : null,
    "release_status" : null,
    "project_id" : null,
    "includes_pattern" : null,
    "excludes_pattern" : null,
    "repository_ids" : null,
    "deployment_policy" : null,
    "parent_repo_name" : null,
    "user_name" : null,
    "remote_url" : "https://123.com",
    "pypi_registry_url" : null,
    "default_deploy_repository" : null,
    "remote_type" : "customize",
    "allow_anonymous" : null,
    "auto_clean_snapshot" : null,
    "snapshot_alive_days" : null,
    "max_unique_snapshots" : null,
    "share_right" : null,
    "nexu_repo" : false,
    "migrate_flag" : 0,
    "obs_speed_bucket" : null,
    "associate_project" : null,
    "package_type" : "maven"
  } ]
}