Manually Synchronizing Images
Description
Existing images must be manually synchronized. Check whether image synchronization succeeded using either of the two ways: - If the response status code is 200 and no errors are reported, the image synchronization succeeded. - Use the SWR console or call the API of querying image repository information, if the synchronized image tag exists in the target organization of the target region, the image synchronization succeeded.
Constraints
None
API Calling
For details, see Calling APIs.
Authorization Information
Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
- If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
URI
POST /v2/manage/namespaces/{namespace}/repos/{repository}/sync_images
|
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. Enter 1 to 128 characters. It must start and end 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. Replace a slash (/) with a dollar sign ($) before you send the request. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
Content-Type |
Yes |
String |
Message body type (format). The value can be application/json or charset=utf-8 application/json. Default value: application/json |
|
X-Auth-Token |
Yes |
String |
User token. The token 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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
imageTag |
Yes |
Array of strings |
Image tag list. |
|
override |
No |
Boolean |
Whether to overwrite. The default value is false, which indicates not to overwrite any nonidentical image that has the same name in the target organization. |
|
remoteNamespace |
Yes |
String |
Target organization. |
|
remoteRegionId |
Yes |
String |
Target region ID. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
[items] |
Array of strings |
Image tags that are synchronized successfully. |
Status code: default
|
Parameter |
Type |
Description |
|---|---|---|
|
[items] |
Array of strings |
Image tags that fail to be synchronized. |
Example Request
POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/sync_images
{
"imageTag" : [ "V1" ],
"override" : true,
"remoteNamespace" : "sdsad",
"remoteRegionId" : "region1"
}
Example Response
[]
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Image synchronization triggered. |
|
400 |
Request error. |
|
401 |
Authentication failed. |
|
404 |
The organization or repository was not found. |
|
500 |
Internal error. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.