文档首页/ 容器镜像服务 SWR/ API参考(基础版)/ API/ 镜像同步管理/ 创建镜像自动同步任务 - CreateImageSyncRepo
更新时间:2026-09-28 GMT+08:00
分享

创建镜像自动同步任务 - CreateImageSyncRepo

功能介绍

创建镜像自动同步任务,帮助您把最新推送的镜像自动同步到其他区域镜像仓库内。 镜像自动同步帮助您把最新推送的镜像自动同步到其他区域镜像仓库内,后期镜像有更新时,目标仓库的镜像也会自动更新,但已有的镜像不会自动同步。已有镜像的同步需要手动操作,详情请参见手动同步镜像。

接口约束

无

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v2/manage/namespaces/{namespace}/repos/{repository}/sync_repo

表1 路径参数

参数

是否必选

参数类型

描述

namespace

是

String

参数解释:

组织名称。用于唯一标识一个组织,组织下的所有镜像仓库都属于该组织。

约束限制:

不涉及。

取值范围:

小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。

默认取值:

不涉及。

repository

是

String

参数解释:

镜像仓库名称过滤关键字,用于模糊匹配镜像仓库列表。与精确匹配的name参数不同,filter支持模糊查询。

约束限制:

不涉及。

取值范围:

小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

消息体的类型(格式),用于指定请求体的MIME类型。

约束限制:

不涉及。

取值范围:

  • application/json;charset=utf-8:使用UTF-8字符集的JSON格式

  • application/json:标准JSON格式

默认取值:

不涉及。

X-Auth-Token

是

String

参数解释:

用户Token。用于调用API时的鉴权。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

remoteRegionId

是

String

参数解释:

目标region ID。可通过查询region列表接口获取。

约束限制:

不涉及。

取值范围:

由小写字母、数字和中划线组成,长度1~64个字符。

默认取值:

不涉及。

remoteNamespace

是

String

参数解释:

目标组织。

约束限制:

不涉及。

取值范围:

小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。

默认取值:

不涉及。

syncAuto

否

Boolean

参数解释:

自动同步。

约束限制:

不涉及。

取值范围:

  • true:开启自动同步

  • false:关闭自动同步

默认取值:

false。

override

否

Boolean

参数解释:

是否覆盖。

约束限制:

不涉及。

取值范围:

  • true:覆盖目的仓库的同名镜像

  • false:不覆盖目的仓库的同名镜像

默认取值:

false。

响应参数

状态码:200

无

请求示例

POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/sync_repo

{
  "remoteRegionId" : "string",
  "remoteNamespace" : "string",
  "syncAuto" : true,
  "override" : true
}

响应示例

无

SDK代码示例

SDK代码示例如下。

 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
46
47
48
49
50
51
52
53
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.swr.v2.region.SwrRegion;
import com.huaweicloud.sdk.swr.v2.*;
import com.huaweicloud.sdk.swr.v2.model.*;


public class CreateImageSyncRepoSolution {

    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);

        SwrClient client = SwrClient.newBuilder()
                .withCredential(auth)
                .withRegion(SwrRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateImageSyncRepoRequest request = new CreateImageSyncRepoRequest();
        request.withNamespace("{namespace}");
        request.withRepository("{repository}");
        CreateImageSyncRepoRequestBody body = new CreateImageSyncRepoRequestBody();
        body.withOverride(true);
        body.withSyncAuto(true);
        body.withRemoteNamespace("string");
        body.withRemoteRegionId("string");
        request.withBody(body);
        try {
            CreateImageSyncRepoResponse response = client.createImageSyncRepo(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());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkswr.v2.region.swr_region import SwrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkswr.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 = SwrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SwrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateImageSyncRepoRequest()
        request.namespace = "{namespace}"
        request.repository = "{repository}"
        request.body = CreateImageSyncRepoRequestBody(
            override=True,
            sync_auto=True,
            remote_namespace="string",
            remote_region_id="string"
        )
        response = client.create_image_sync_repo(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := swr.SwrClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := swr.NewSwrClient(hcClient)

    request := &model.CreateImageSyncRepoRequest{}
	request.Namespace = "{namespace}"
	request.Repository = "{repository}"
	overrideCreateImageSyncRepoRequestBody:= true
	syncAutoCreateImageSyncRepoRequestBody:= true
	request.Body = &model.CreateImageSyncRepoRequestBody{
		Override: &overrideCreateImageSyncRepoRequestBody,
		SyncAuto: &syncAutoCreateImageSyncRepoRequestBody,
		RemoteNamespace: "string",
		RemoteRegionId: "string",
	}
	response, err := client.CreateImageSyncRepo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

创建成功

400

错误的请求

401

鉴权失败

404

组织或镜像仓库不存在

500

内部错误

错误码

请参见错误码。

相关文档