Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to adjust the availability zone distribution of MongoDB cloud database nodes. You can specify the primary AZ and total availability zone distribution info to complete node distribution adjustment.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyInstanceAz. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-25. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID, such as cmgo-p8vn****. Log in to the MongoDB console and copy the instance ID from the instance list. |
| PrimaryNodeZone | Yes | String | Availability zone ID where the primary node is located. For the method for obtaining, please see Regions and Availability Zones. |
| SecondaryNodeZone.N | Yes | Array of String | ID list of the availability zone where the secondary node resides. |
| HiddenNodeZone | No | String | If the current instance has no configuration for Hidden nodes, this parameter is not required. |
| ReadonlyNodeZone.N | No | Array of String | List of AZ IDs where read-only nodes reside. |
| InMaintenance | No | Integer | Specify the time policy for executing the availability zone switch.
|
| Parameter Name | Type | Description |
|---|---|---|
| DealId | String | Order ID for availability zone adjustment. |
| 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. |
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceAz
<Common request parameters>
{
"InstanceId": "cmgo-p9d****",
"PrimaryNodeZone": "ap-guangzhou-2",
"HiddenNodeZone": "ap-guangzhou-3",
"SecondaryNodeZone": [
"ap-guangzhou-4"
],
"ReadonlyNodeZone": [
null
],
"InMaintenance": null
}
{
"Response": {
"DealId": "2025080702700316299****",
"RequestId": "87f3a779-9b2e-475f-bcf5-966cffbbbe9f"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error |
| InvalidParameter | Parameter error |
| InvalidParameterValue.CheckAppIdFailed | appId verification failed. |
| InvalidParameterValue.IllegalInstanceStatus | Invalid instance status |
| InvalidParameterValue.StatusAbnormal | The instance is in a status where operations are not allowed. |
| ResourceInsufficient | Insufficient resources. |
文档反馈