Domain name for API request: ckafka.intl.tencentcloudapi.com.
This API is used to set instance attributes.
A maximum of 100 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: ModifyInstanceAttributes. |
| Version | Yes | String | Common Params. The value used for this API: 2019-08-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | ckafka cluster instance Id, which can be obtained through the DescribeInstances API |
| MsgRetentionTime | No | Integer | Maximum retention time of instance log, in minutes, with a maximum of 90 days and a minimum of 1 min |
| InstanceName | No | String | ckafka cluster instance Name |
| Config | No | ModifyInstanceAttributesConfig | Instance configuration |
| DynamicRetentionConfig | No | DynamicRetentionTime | Dynamic message retention policy configuration |
| RebalanceTime | No | Integer | Used to modify the scheduled task execution time for edition upgrade or upgrade version, Unix timestamp, accurate to the second |
| PublicNetwork | No | Integer | Public network bandwidth: minimum 3Mbps, maximum 999Mbps. Only the Pro Edition supports filling in. |
| MaxMessageByte | No | Integer | Single message size at the instance level (unit: byte) Maximum 12582912 (excluding) Minimum 1024 (excluding) |
| UncleanLeaderElectionEnable | No | Integer | Whether to allow unsynchronized replicas to be elected as leader: 1 Enable 0 Disable |
| DeleteProtectionEnable | No | Integer | Instance deletion protection switch: 1: enabled 0: disabled |
| RetentionBytes | No | Integer | Message retention size at the instance level Measurement unit: byteDefault value: -1 Message retention size at the instance level |
| AdminSecurity | No | Boolean | Ban Status for high-risk admin interface; true to ban high-risk adminApi; no support for turning on after closing, only supported in Pro Edition; default false, no action taken for high-risk admin interface |
| TransactionalIdExpirationMs | No | Integer | The maximum idle time of a transaction ID. Uncommitted transactions that time out will be marked with expiration. Value ranges from 3600000 to 604800000.Unit: ms |
| Parameter Name | Type | Description |
|---|---|---|
| Result | JgwOperateResponse | Returned result |
| 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: ckafka.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceAttributes
<Common request parameters>
{
"InstanceId": "ckafka-test"
}
{
"Response": {
"Result": {
"ReturnCode": "0",
"ReturnMessage": "ok",
"Data": {
"FlowId": 0,
"RouteDTO": {
"RouteId": 0
}
}
},
"RequestId": "84770b4b-df34-4ccf-8e22-41d3b1d0fe0d"
}
}
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 |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.InstanceNotExist | The instance does not exist. |
| InvalidParameterValue.RepetitionValue | The parameter already exists. |
| InvalidParameterValue.SubnetIdInvalid | Invalid subnet ID. |
| InvalidParameterValue.SubnetNotBelongToZone | The subnet is not in the zone. |
| InvalidParameterValue.VpcIdInvalid | Invalid VPC ID. |
| InvalidParameterValue.WrongAction | The value of the Action parameter is incorrect. |
| InvalidParameterValue.ZoneNotSupport | The zone is not supported. |
| ResourceUnavailable | The resource is unavailable. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.BatchDelInstanceLimit | The batch instance deletion limit is reached. |
| UnsupportedOperation.OssReject | Oss rejected the operation. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários