Modifying an Image Replication Policy
Function
This API is used to modify an image replication policy.
Constraints
None.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/instances/{instance_id}/replication/policies/{policy_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
ID of an SWR Enterprise Edition instance. |
policy_id |
Yes |
Integer |
Image replication policy ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Policy name. The value can contain 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
description |
No |
String |
Policy description. |
src_registry |
No |
ReplicationRegistry object |
This parameter is mandatory for image pull. Either src_registry or dest_registry must be transferred. |
dest_registry |
No |
ReplicationRegistry object |
This parameter is mandatory for image push. Either src_registry or dest_registry must be transferred. |
dest_namespace |
No |
String |
Name of the target namespace. By default, the value is left empty. |
filters |
Yes |
Array of Filter objects |
Filter. |
repo_scope_mode |
Yes |
String |
Repository selection mode. The value options are regular and selection. |
trigger |
Yes |
TriggerConfig object |
Trigger configuration. |
override |
No |
Boolean |
Whether to overwrite an image. The default value is false. |
enabled |
Yes |
Boolean |
Whether to enable a resource. The default value is false. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Filter type. The options are name and tag. |
value |
Yes |
String |
Regular expression corresponding to the filter type. If type is set to name, the regular expression is the namespace and artifact repository, for example, library/**. If type is set to tag, the regular expression is the artifact tag, for example, **repo and *tag. If there are multiple regular expressions, separate them with commas (,) and add {} at the outermost layer, for example, library/{test,test,*test}. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Trigger type. For image signing and retention policies, the options are manual and scheduled (scheduled + manual). For image replication policies, the options are manual, scheduled (scheduled + manual), and event_based (event-triggered + manual). |
trigger_settings |
No |
TriggerSetting object |
Trigger settings. This parameter is required only when type is set to scheduled. |
Response Parameters
Status code: 200
The image replication policy is updated successfully.
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Example Requests
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" }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Java
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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
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("<YOUR REGION>")) .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("manual") .withTriggerSettings(triggerSettingsTrigger); List<Filter> 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
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 58 59 60 61 62 63 64 |
# 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("<YOUR REGION>")) \ .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
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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := swr.NewSwrClient( swr.SwrClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateInstanceReplicationPolicyRequest{} request.InstanceId = "{instance_id}" request.PolicyId = int32({policy_id}) cronTriggerSettings:= "" triggerSettingsTrigger := &model.TriggerSetting{ Cron: &cronTriggerSettings, } triggerbody := &model.TriggerConfig{ Type: "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) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The image replication policy is updated successfully. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
Access denied. |
404 |
Resource not found. |
500 |
Internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot