# 修改实例SSL相关配置 - ModifyInstanceSslConfig #### 功能介绍 修改实例SSL相关配置。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hrm/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hrm/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:instance:modifySslSwitch | Write | rocketmq | - g:ResourceTag/\ - g:EnterpriseProjectId | dms:instance:modify | - | #### URI POST /v2/{project_id}/{engine}/instances/{instance_id}/plain-ssl-switch 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hrm/hrm-api-0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | engine | 是 | String | **参数解释**： 消息引擎类型。 **约束限制**： 不涉及。 **取值范围**： - rocketmq：RocketMQ消息引擎。 - reliability：RocketMQ消息引擎别称。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | tls_mode | 否 | String | **参数解释**： 协议模式。 **约束限制**： 不涉及。 **取值范围**： - SSL：服务端与客户端之间通过密文传输，安全性较高，性能较低。 - PLAINTEXT：服务端与客户端之间通过明文传输，安全性较低，性能较高。 - PERMISSIVE：服务端与客户端之间既能通过明文传输又能通过密文传输，传输方式由客户端决定。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 任务ID。 **取值范围**： 不涉及。 | | tls_mode | String | **参数解释**： 协议模式。 **取值范围**： - SSL：服务端与客户端之间通过密文传输，安全性较高，性能较低。 - PLAINTEXT：服务端与客户端之间通过明文传输，安全性较低，性能较高。 - PERMISSIVE：服务端与客户端之间既能通过明文传输又能通过密文传输，传输方式由客户端决定。 | #### 请求示例 ``` 'POST https://{endpoint}/v2/{project_id}/{engine}/instances/{instance_id}/plain-ssl-switch' { "tls_mode" : "SSL" } ``` #### 响应示例 **状态码：200** 修改成功。 ``` { "job_id" : "8abfa7b3971f12a20197207ea77161af", "tls_mode" : "SSL" } ``` #### 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.rocketmq.v2.region.RocketMQRegion; import com.huaweicloud.sdk.rocketmq.v2.*; import com.huaweicloud.sdk.rocketmq.v2.model.*; public class ModifyInstanceSslConfigSolution { 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); RocketMQClient client = RocketMQClient.newBuilder() .withCredential(auth) .withRegion(RocketMQRegion.valueOf("")) .build(); ModifyInstanceSslConfigRequest request = new ModifyInstanceSslConfigRequest(); request.withEngine("{engine}"); request.withInstanceId("{instance_id}"); PlainSSLSwitchRep body = new PlainSSLSwitchRep(); body.withTlsMode("SSL"); request.withBody(body); try { ModifyInstanceSslConfigResponse response = client.modifyInstanceSslConfig(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 huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrocketmq.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 = RocketMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RocketMQRegion.value_of("")) \ .build() try: request = ModifyInstanceSslConfigRequest() request.engine = "{engine}" request.instance_id = "{instance_id}" request.body = PlainSSLSwitchRep( tls_mode="SSL" ) response = client.modify_instance_ssl_config(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" rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/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 := rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := rocketmq.NewRocketMQClient(hcClient) request := &model.ModifyInstanceSslConfigRequest{} request.Engine = "{engine}" request.InstanceId = "{instance_id}" tlsModePlainSslSwitchRep:= "SSL" request.Body = &model.PlainSslSwitchRep{ TlsMode: &tlsModePlainSslSwitchRep, } response, err := client.ModifyInstanceSslConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/sdk?api=ModifyInstanceSslConfig)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 修改成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hrm/ErrorCode.html)。