Updated on 2025-12-18 GMT+08:00

Modifying SSL of an Instance

Function

This API is used to modify the SSL configuration of an instance.

URI

POST /v2/{project_id}/{engine}/instances/{instance_id}/plain-ssl-switch

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Definition

Engine.

Constraints

N/A

Range

  • rocketmq: RocketMQ message engine.

  • reliability: RocketMQ message engine alias.

Default Value

N/A

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

tls_mode

No

String

Protocol mode.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

tls_mode

String

Protocol mode.

Example Requests

'POST https://{endpoint}/v2/{project_id}/{engine}/instances/{instance_id}/plain-ssl-switch'

{
  "tls_mode" : "ssl"
}

Example Responses

Status code: 200

success

{
  "job_id" : "8abfa7b3971f12a20197207ea77161af",
  "tls_mode" : "ssl"
}

Status Codes

Status Code

Description

200

success

Error Codes

See Error Codes.