Obtaining Information About the Repository Associated with an Image Synchronization Task

Function

This API is used to obtain information about the image repository associated with an image synchronization task.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/image/image-sync/tasks/{task_id}/registries

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
task_id	Yes	String	Definition Task ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
registry_name	No	String	Definition Repository Name Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
registry_type	No	String	Definition Image repository type. If this parameter is not specified, all types are returned by default. To query multiple types, separate them with commas (,). Range Harbor harbor Jfrog jfrog SwrPrivate: SWR private repository SwrShared: SWR shared repository SwrEnterprise: SWR enterprise repository Other: other repository
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
sync_status	No	String	Definition Synchronization status. Constraints N/A Range finished: The synchronization is complete. running: The synchronization is in progress. failed: The synchronization failed. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data_list	Array of AssociateRegistriesResponseInfo objects	Image repository list
total_num	Integer	Total number of image repositories associated with the synchronization task.

**Table 5** AssociateRegistriesResponseInfo
Parameter	Type	Description
registry_id	String	Image repository ID.
registry_name	String	Image repository name.
registry_type	String	Definition Image repository type. Range SwrPrivate: SWR private repository SwrShared: SWR shared repository SwrEnterprise: SWR enterprise repository Harbor: Harbor repository Jfrog: JFrog repository Other: other repository
sync_status	String	Synchronization status. The options are as follows: finished running failed
failed_reason	String	Failure cause

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "registry_id" : "mock-registry-id-swr-private",
    "registry_name" : "Swr-private",
    "registry_type" : "SwrPrivate",
    "sync_status" : "finished"
  } ]
}