# 修改镜像同步策略 - UpdateInstanceReplicationPolicy #### 功能介绍 修改镜像同步策略 #### 接口约束 无 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-swr2/swr_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-swr2/swr_02_0131.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | swr:instance:updateReplicationPolicy | Write | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId - swr:TargetRegion - swr:SourceRegion - swr:TargetUrls - swr:SourceUrls | - | - | #### URI PUT /v2/{project_id}/instances/{instance_id}/replication/policies/{policy_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | | instance_id | 是 | String | 企业仓库实例ID | | policy_id | 是 | Integer | 同步策略ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | 策略名称, 1-256字符组成，只能包含英文大小写、数字、汉字、中划线和下划线。 | | description | 否 | String | 策略描述 | | src_registry | 否 | [ReplicationRegistry] object | Pull-based时必选, src_registry跟dest_registry二选一 | | dest_registry | 否 | [ReplicationRegistry] object | Push-based时必选， src_registry跟dest_registry二选一 | | dest_namespace | 否 | String | 目标命名空间名，默认为空值 | | filters | 是 | Array of [Filter] objects | 过滤器 | | repo_scope_mode | 是 | String | repo的选择方式，regular，selection | | trigger | 是 | [TriggerConfig] object | 触发配置 | | override | 否 | Boolean | 是否覆盖，默认为false | | enabled | 是 | Boolean | 是否启用，默认为false | 表4ReplicationRegistry | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | Long | The registry ID. | 表5Filter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | 过滤类型 取值范围： - name：镜像 - tag：版本 | | value | 是 | String | 过滤类型对应的正则表达式(type为name时，对应的是命名空间及制品仓库，例如library/\*\*； type为tag时，对应的是制品版本，例如：**repo和**tag； 正则表达式有多个时，用英文逗号分隔，且在最外层加{}，如library/{test,test\*,\*test}) | 表6TriggerConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | 触发类型，老化规则只支持manual(手动)、scheduled(定时+手动)；同步策略支持manual(手动)、scheduled(定时+手动)、event_based(事件触发+手动);镜像签名支持manual(手动)、event_based(事件触发+手动) | | trigger_settings | 否 | [TriggerSetting] object | 触发设置，只有type为scheduled的时候，才需要设置 | 表7TriggerSetting | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | cron | 否 | String | 定时设置，cron格式描述 '\* \* \* \* \* \*'。cron 基于 UTC 时间。 | #### 响应参数 **状态码：200** 成功更新策略信息 **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/replication/policies/{policy_id} { "description" : "test", "dest_namespace" : "", "name" : "test", "dest_registry" : { "id" : 6 }, "trigger" : { "trigger_settings" : { "cron" : "" }, "type" : "manual" }, "filters" : [ { "type" : "name", "value" : "**/**" }, { "type" : "tag", "value" : "**" } ], "override" : true, "enabled" : true, "repo_scope_mode" : "regular" } ``` #### 响应示例 无 #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.*; import java.util.List; import java.util.ArrayList; public class UpdateInstanceReplicationPolicySolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SwrClient client = SwrClient.newBuilder() .withCredential(auth) .withRegion(SwrRegion.valueOf("")) .build(); UpdateInstanceReplicationPolicyRequest request = new UpdateInstanceReplicationPolicyRequest(); request.withInstanceId("{instance_id}"); request.withPolicyId({policy_id}); UpdateReplicationPolicyRequestBody body = new UpdateReplicationPolicyRequestBody(); TriggerSetting triggerSettingsTrigger = new TriggerSetting(); triggerSettingsTrigger.withCron(""); TriggerConfig triggerbody = new TriggerConfig(); triggerbody.withType(TriggerConfig.TypeEnum.fromValue("manual")) .withTriggerSettings(triggerSettingsTrigger); List listbodyFilters = new ArrayList<>(); listbodyFilters.add( new Filter() .withType("name") .withValue("**/**") ); listbodyFilters.add( new Filter() .withType("tag") .withValue("**") ); ReplicationRegistry destRegistrybody = new ReplicationRegistry(); destRegistrybody.withId(6L); body.withEnabled(true); body.withOverride(true); body.withTrigger(triggerbody); body.withRepoScopeMode("regular"); body.withFilters(listbodyFilters); body.withDestNamespace(""); body.withDestRegistry(destRegistrybody); body.withDescription("test"); body.withName("test"); request.withBody(body); try { UpdateInstanceReplicationPolicyResponse response = client.updateInstanceReplicationPolicy(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()); } } } ``` - [Python] ``` # 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SwrClient.new_builder() \ .with_credentials(credentials) \ .with_region(SwrRegion.value_of("")) \ .build() try: request = UpdateInstanceReplicationPolicyRequest() request.instance_id = "{instance_id}" request.policy_id = {policy_id} triggerSettingsTrigger = TriggerSetting( cron="" ) triggerbody = TriggerConfig( type="manual", trigger_settings=triggerSettingsTrigger ) listFiltersbody = [ Filter( type="name", value="**/**" ), Filter( type="tag", value="**" ) ] destRegistrybody = ReplicationRegistry( id=6 ) request.body = UpdateReplicationPolicyRequestBody( enabled=True, override=True, trigger=triggerbody, repo_scope_mode="regular", filters=listFiltersbody, dest_namespace="", dest_registry=destRegistrybody, description="test", name="test" ) response = client.update_instance_replication_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := swr.SwrClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := swr.NewSwrClient(hcClient) request := &model.UpdateInstanceReplicationPolicyRequest{} request.InstanceId = "{instance_id}" request.PolicyId = int32({policy_id}) cronTriggerSettings:= "" triggerSettingsTrigger := &model.TriggerSetting{ Cron: &cronTriggerSettings, } triggerbody := &model.TriggerConfig{ Type: model.GetTriggerConfigTypeEnum().MANUAL, TriggerSettings: triggerSettingsTrigger, } var listFiltersbody = []model.Filter{ { Type: "name", Value: "**/**", }, { Type: "tag", Value: "**", }, } destRegistrybody := &model.ReplicationRegistry{ Id: int64(6), } overrideUpdateReplicationPolicyRequestBody:= true destNamespaceUpdateReplicationPolicyRequestBody:= "" descriptionUpdateReplicationPolicyRequestBody:= "test" request.Body = &model.UpdateReplicationPolicyRequestBody{ Enabled: true, Override: &overrideUpdateReplicationPolicyRequestBody, Trigger: triggerbody, RepoScopeMode: "regular", Filters: listFiltersbody, DestNamespace: &destNamespaceUpdateReplicationPolicyRequestBody, DestRegistry: destRegistrybody, Description: &descriptionUpdateReplicationPolicyRequestBody, Name: "test", } response, err := client.UpdateInstanceReplicationPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SWR/sdk?api=UpdateInstanceReplicationPolicy)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功更新策略信息 | | 400 | 错误的请求 | | 401 | 鉴权失败 | | 403 | 禁止访问 | | 404 | 未找到资源 | | 500 | 内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-swr2/ErrorCode.html)。