# 修改实例信息 - UpdateInstance #### 功能介绍 修改缓存实例的信息，可修改信息包括实例名称、描述、端口号、备份策略、维护时间窗开始和结束时间以及安全组。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:instance:updateInstanceAttribute | Write | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ - dcs:backupEnabled | dcs:instance:modify | - vpc:ports:get - vpc:ports:update | #### URI PUT /v2/{project_id}/instances/{instance_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。可通过DCS控制台进入实例详情界面查看。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 实例名称。 **约束限制**： 由英文字符开头，只能由英文字母、数字、中划线和下划线组成，名称长度为4到64位的字符串。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | description | 否 | String | **参数解释**： 实例的描述信息。 **约束限制**： 长度不超过1024的字符串。 说明： \\与"在json报文中属于特殊字符，如果参数值中需要显示\\或者"字符，请在字符前增加转义字符\\，比如\\或者"。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | port | 否 | Integer | **参数解释**： 实例自定义端口。 **约束限制**： 只有创建Redis4.0及以上版本的基础版实例才支持自定义端口，企业版实例不支持自定义端口，默认端口为6379。 创建Redis实例时，如果没发送该参数或该参数为空，表示实例使用默认端口6379。如果自定义端口，端口范围为1\~65535的任意数字。 **取值范围**： 1\~65535 **默认取值**： 6379 | | rename_commands | 否 | [RenameCommandRequest] object | **参数解释**： 命令重命名列表。 | | maintain_begin | 否 | String | **参数解释**： 维护时间窗开始时间。 **约束限制**： 必须是UTC时间，格式为HH:mm:ss - 维护时间窗开始和结束时间必须为指定的时间段，可参考[查询维护时间窗时间段](https://support.huaweicloud.com/api-dcs/ListMaintenanceWindows.html)获取。 - 开始时间必须为18:00:00、19:00:00等整点时间。 - 该参数不能单独为空，若该值为空，则结束时间也为空。 **取值范围**： 不涉及。 **默认取值**： 18:00:00。 | | maintain_end | 否 | String | **参数解释**： 维护时间窗结束时间。 **约束限制**： 必须是UTC时间，格式为HH:mm:ss - 维护时间窗开始和结束时间必须为指定的时间段，可参考[查询维护时间窗时间段](https://support.huaweicloud.com/api-dcs/ListMaintenanceWindows.html)获取。 - 开始时间必须为18:00:00、19:00:00等整点时间。 - 该参数不能单独为空，若该值为空，则结束时间也为空。 **取值范围**： 不涉及。 **默认取值**： 19:00:00。 | | security_group_id | 否 | String | **参数解释**： 指定实例所属的安全组。 当engine为Redis且engine_version为4.0及以上版本基础版实例时，该参数为可选。Redis4.0及以上版本基础版实例不支持安全组控制访问(会设置为默认参数值securityGroupId)，只支持白名单控制。 获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 - 方法2：通过虚拟私有云服务的[查询安全组列表](https://support.huaweicloud.com/api-vpc/vpc_sg01_0002.html)API接口查询。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_backup_policy | 否 | [BackupPolicy] object | **参数解释**： 备份策略，实例类型为主备和集群时支持。 | 表3RenameCommandRequest | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | command | 否 | String | **参数解释**： 可命令重命名的命令command。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | flushall | 否 | String | **参数解释**： 可命令重命名的命令flushall。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | flushdb | 否 | String | **参数解释**： 可命令重命名的命令flushdb。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | hgetall | 否 | String | **参数解释**： 可命令重命名的命令hgetall。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | keys | 否 | String | **参数解释**： 可命令重命名的命令hgetall。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4BackupPolicy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | backup_type | 是 | String | **参数解释**： 备份类型。 **约束限制**： 不涉及。 **取值范围**： - auto：自动备份。 - manual：手动备份。 **默认取值**： 不涉及。 | | save_days | 否 | Integer | **参数解释**： 当backup_type设置为auto时，该参数为必填。 保留天数，单位：天，取值范围：1-7。由自动切换为手动时，保留自动备份策略信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | periodical_backup_plan | 否 | [BackupPlanRequest] object | **参数解释**： 备份计划。 **约束限制**： 当backup_type设置为auto时，该参数为必填。由自动切换为手动时，保留自动备份策略信息。 | 表5BackupPlanRequest | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | timezone_offset | 否 | String | **参数解释**： 备份的时区。该参数已废弃，没有实际作用。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | backup_at | 是 | Array of integers | **参数解释**： 每周的周几开始备份。由自动切换为手动时，保留自动备份策略信息。取值1-7，分别表示星期一到星期日。 **约束限制**： 不涉及。 | | period_type | 是 | String | **参数解释**： 备份周期类型，目前支持"weekly"。由自动切换为手动时，保留自动备份策略信息。 **约束限制**： 不涉及。 **取值范围**： weekly：每星期。 **默认取值**： 不涉及。 | | begin_at | 是 | String | **参数解释**： 备份开始执行时间，该时间为UTC时间，例如"00:00-01:00"代表UTC时间0点开始执行备份。只能是整点时间段，间隔时间限定为一个小时。由自动切换为手动时，保留自动备份策略信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：204** 无 #### 请求示例 修改指定实例的信息，修改实例名称为dcs002，端口为6379，设置自动备份策略。 ``` PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id} { "name" : "dcs002", "description" : "instance description", "port" : 6379, "maintain_begin" : "18:00:00", "maintain_end" : "19:00:00", "security_group_id" : "18e9309f-f81a-4749-bb21-f74576292162", "instance_backup_policy" : { "backup_type" : "auto", "save_days" : 1, "periodical_backup_plan" : { "backup_at" : [ 1, 2, 3, 4, 6, 7 ], "period_type" : "weekly", "begin_at" : "00:00-01:00" } } } ``` #### 响应示例 无 #### SDK代码示例 SDK代码示例如下。 - [Java] 修改指定实例的信息，修改实例名称为dcs002，端口为6379，设置自动备份策略。 ``` 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.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateInstanceSolution { 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); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("")) .build(); UpdateInstanceRequest request = new UpdateInstanceRequest(); request.withInstanceId("{instance_id}"); ModifyInstanceBody body = new ModifyInstanceBody(); List listPeriodicalBackupPlanBackupAt = new ArrayList<>(); listPeriodicalBackupPlanBackupAt.add(1); listPeriodicalBackupPlanBackupAt.add(2); listPeriodicalBackupPlanBackupAt.add(3); listPeriodicalBackupPlanBackupAt.add(4); listPeriodicalBackupPlanBackupAt.add(6); listPeriodicalBackupPlanBackupAt.add(7); BackupPlan periodicalBackupPlanInstanceBackupPolicy = new BackupPlan(); periodicalBackupPlanInstanceBackupPolicy.withBackupAt(listPeriodicalBackupPlanBackupAt) .withPeriodType("weekly") .withBeginAt("00:00-01:00"); BackupPolicy instanceBackupPolicybody = new BackupPolicy(); instanceBackupPolicybody.withBackupType("auto") .withSaveDays(1) .withPeriodicalBackupPlan(periodicalBackupPlanInstanceBackupPolicy); body.withInstanceBackupPolicy(instanceBackupPolicybody); body.withSecurityGroupId("18e9309f-f81a-4749-bb21-f74576292162"); body.withMaintainEnd("19:00:00"); body.withMaintainBegin("18:00:00"); body.withPort(6379); body.withDescription("instance description"); body.withName("dcs002"); request.withBody(body); try { UpdateInstanceResponse response = client.updateInstance(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] 修改指定实例的信息，修改实例名称为dcs002，端口为6379，设置自动备份策略。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.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 = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("")) \ .build() try: request = UpdateInstanceRequest() request.instance_id = "{instance_id}" listBackupAtPeriodicalBackupPlan = [ 1, 2, 3, 4, 6, 7 ] periodicalBackupPlanInstanceBackupPolicy = BackupPlan( backup_at=listBackupAtPeriodicalBackupPlan, period_type="weekly", begin_at="00:00-01:00" ) instanceBackupPolicybody = BackupPolicy( backup_type="auto", save_days=1, periodical_backup_plan=periodicalBackupPlanInstanceBackupPolicy ) request.body = ModifyInstanceBody( instance_backup_policy=instanceBackupPolicybody, security_group_id="18e9309f-f81a-4749-bb21-f74576292162", maintain_end="19:00:00", maintain_begin="18:00:00", port=6379, description="instance description", name="dcs002" ) response = client.update_instance(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] 修改指定实例的信息，修改实例名称为dcs002，端口为6379，设置自动备份策略。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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 := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) request := &model.UpdateInstanceRequest{} request.InstanceId = "{instance_id}" var listBackupAtPeriodicalBackupPlan = []int32{ int32(1), int32(2), int32(3), int32(4), int32(6), int32(7), } periodicalBackupPlanInstanceBackupPolicy := &model.BackupPlan{ BackupAt: listBackupAtPeriodicalBackupPlan, PeriodType: "weekly", BeginAt: "00:00-01:00", } saveDaysInstanceBackupPolicy:= int32(1) instanceBackupPolicybody := &model.BackupPolicy{ BackupType: "auto", SaveDays: &saveDaysInstanceBackupPolicy, PeriodicalBackupPlan: periodicalBackupPlanInstanceBackupPolicy, } securityGroupIdModifyInstanceBody:= "18e9309f-f81a-4749-bb21-f74576292162" maintainEndModifyInstanceBody:= "19:00:00" maintainBeginModifyInstanceBody:= "18:00:00" portModifyInstanceBody:= int32(6379) descriptionModifyInstanceBody:= "instance description" nameModifyInstanceBody:= "dcs002" request.Body = &model.ModifyInstanceBody{ InstanceBackupPolicy: instanceBackupPolicybody, SecurityGroupId: &securityGroupIdModifyInstanceBody, MaintainEnd: &maintainEndModifyInstanceBody, MaintainBegin: &maintainBeginModifyInstanceBody, Port: &portModifyInstanceBody, Description: &descriptionModifyInstanceBody, Name: &nameModifyInstanceBody, } response, err := client.UpdateInstance(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DCS/sdk?api=UpdateInstance&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 204 | 修改缓存实例成功。 | | 400 | 非法请求。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。