Obtaining Information on an Image Synchronization Task_Image Synchronization Management_APIs_API Reference (Basic Edition)_SoftWare Repository for Container-Huawei Cloud

Function

This API is used to obtain information required for an image synchronization task.

Constraints

None

Calling Method

For details, see Calling APIs.

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, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

swr:repo:getSyncRepoJobInfo

Read

repo *

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
swr:repo:getSyncRepoJobInfo	Read	repo *	-	-	-

URI

GET /v2/manage/namespaces/{namespace}/repos/{repository}/sync_job

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
namespace	Yes	String	Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.
repository	Yes	String	Image repository name. The name contains 1 to 128 characters, starting and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), slashes (/), underscores (_), and hyphens (-) are allowed. Periods, slashes, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. If the parameter value contains a slash (/), replace it with a dollar sign ($) before sending the request.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
filter	Yes	String	Enter limit::{limit}\|offset::{offset}\|order::{order}. {limit} indicates the number of returned records, and {offset} indicates the start index. Parameters offset and limit should be used together and are mandatory. {order} indicates the sorting type (optional). The value can be desc (descending order) or asc (ascending order).

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Possible values: application/json;charset=utf-8 application/json
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
Content-Range	String	offset (start index) – count (number of records on the current page)/total (total number of records)

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of SyncJob objects

**Table 6** SyncJob
Parameter	Type	Description
createdAt	String	Creation time. It is the UTC standard time. Users need to calculate the offset based on the local time. For example, GMT+8 is 8 hours ahead the GMT time.
domainID	String	Tenant ID
domainName	String	Tenant name
id	Integer	ID
namespace	String	Organization name
override	Boolean	Overwritten or not
remoteNamespace	String	Target organization
remoteRegionId	String	Target region
repoName	String	Repository name
status	String	Synchronization status. Options: waiting running success failed timeout cancel existed
syncOperatorId	String	Operator ID
syncOperatorName	String	Operator account name
tag	String	Image tag
updatedAt	String	updatedAt

Example Requests

GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/sync_job

Example Responses

Status code: 200

[ {
  "createdAt" : "2020-03-12T08:11:36.518144Z",
  "domainID" : "0657**************************f60",
  "domainName" : "h**********4",
  "id" : 1,
  "namespace" : "test",
  "override" : false,
  "remoteNamespace" : "remtens",
  "remoteRegionId" : "regionID",
  "repoName" : "testrepo",
  "status" : "success",
  "syncOperatorId" : "065***********************10",
  "syncOperatorName" : "h**********4",
  "tag" : "8",
  "updatedAt" : "2020-03-12T08:11:41.505499Z"
} ]

Status Codes

Status Code	Description
200	The query succeeded.
400	An request error occurred.
401	The authentication failed.
404	The organization, image repository, or task does not exist.
500	An internal error occurred.

Error Codes

See Error Codes.

Obtaining Information on an Image Synchronization Task