Updates the IP address whitelist of an ApsaraMQ for Kafka instance. Only IP addresses and ports that are configured in the IP address whitelist of an instance can access the instance.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
alikafka:UpdateInstance | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region where the instance resides. | cn-hangzhou |
UpdateType | string | Yes | The type of configuration change. Valid values:
| add |
PortRange | string | Yes | The port range. Valid values:
This parameter must correspond to AllowdedListType. | 9092/9092 |
AllowedListType | string | Yes | The type of the whitelist. Valid values:
| vpc |
AllowedListIp | string | Yes | The IP addresses that you want to manage. You can specify a CIDR block. Example: 192.168.0.0/16.
| 0.0.0.0/0 |
InstanceId | string | Yes | The ID of the instance. | alikafka_pre-cn-0pp1cng20*** |
Description | string | No | The description of the whitelist. | tf-testAccEcsImageConfigBasic3549descriptionChange |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": 200,
"Message": "operation success.",
"RequestId": "17D425C2-4EA3-4AB8-928D-E10511ECF***",
"Success": true
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | WHITE.PARAM.ERROR | %s. Please check and try again later. |
400 | WHITE.OVER.LENGTH.ERROR | %s. Please check and try again later. |
400 | WHITE.IPLIST.OVERLONG.ERROR | %s. Please check and try again later. |
400 | WHITE.IP.ILLEGAL.ERROR | %s. Please check and try again later. |
400 | WHITE.IP.ALREADY.EXISTS.ERROR | %s. Please check and try again later. |
400 | WHITE.DELETE.ERROR | %s. Please check and try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-09-20 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
|