ModifyInstance

Last updated:2026-01-13 21:49:32

ModifyInstance

Last updated: 2026-01-13 21:49:32

1. API Description

Domain name for API request: mqtt.intl.tencentcloudapi.com.

This API is used to modify instance attributes. Only running clusters can call this API to perform configuration change.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyInstance.
Version	Yes	String	Common Params. The value used for this API: 2024-05-16.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	tencent cloud MQTT instance ID, obtained from the DescribeInstanceList api or console.
Name	No	String	Specifies the instance name to be modified, cannot be empty, 3-64 characters, only comprised of digits, letters, "-", and "_".
Remark	No	String	Specifies the remark information to be modified, with a maximum of 128 characters.
SkuCode	No	String	Specifies the configuration specification to be changed. Basic version and professional edition clusters cannot be upgraded to platinum version specifications. platinum edition clusters cannot be downgraded to basic version and enhanced specifications.
AuthorizationPolicy	No	Boolean	Authorization policy switch.
UseDefaultServerCert	No	Boolean	Specifies whether to use the default server certificate.
X509Mode	No	String	TLS: one-way authentication. mTLS. specifies mutual authentication. BYOC: one device, one certificate.
MessageRate	No	Integer	Specifies the speed limit unit for client message send and receive in messages per second.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example

This example shows you the example.

Input Example

POST / HTTP/1.1
Host: mqtt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMQTTInstance
<Common request parameters>

{
    "InstanceId": "mqtt-47ka4rdr",
    "Name": "instance-2",
    "Remark": "ramark2"
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "RequestId": "9955522b-ac27-46c1-8a16-3ed6f98f9c5c"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
FailedOperation.CallTrade	Transaction exception.
FailedOperation.InstanceNotReady	FailedOperation.InstanceNotReady
FailedOperation.NotSupportDisableAuthorizationPolicy	The authorization policy does not support being disabled.
ResourceUnavailable	Resources are unavailable.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud