All Products
Search
Document Center

Message Queue for Apache Kafka:UpdateAllowedIp

Last Updated:Nov 18, 2022

Updates an IP address whitelist.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance.

cn-hangzhou
UpdateTypestringYes

The update operation. Valid values:

  • add: the add operation.
  • delete: the delete operation.
add
PortRangestringYes

The port range. Valid values:

  • 9092/9092: the port range for access from a virtual private cloud (VPC).
  • 9093/9093: the port range for access from the Internet.

The value of this parameter must match the value of AllowdedListType.

9092/9092
AllowedListTypestringYes

The type of the whitelist. Valid values:

  • vpc: a whitelist for access from a VPC.
  • internet: a whitelist for access from the Internet.
vpc
AllowedListIpstringYes

The IP addresses and CIDR blocks that you want to manage. You can specify a CIDR block, such as 192.168.0.0/16.

  • If the UpdateType parameter is set to add, specify one or more IP addresses or CIDR blocks for this parameter. Make sure that you separate multiple IP addresses or CIDR blocks with commas (,).
  • If the UpdateType parameter is set to delete, specify only one IP address or CIDR block.
  • Exercise caution when you delete IP addresses or CIDR blocks.
0.0.0.0/0
InstanceIdstringYes

The ID of the instance.

alikafka_pre-cn-0pp1cng20***
DescriptionstringNo

The description of the whitelist.

tf-testAccEcsImageConfigBasic3549descriptionChange

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code returned. The HTTP status code 200 indicates that the request is successful.

200
Messagestring

The returned message.

operation success.
RequestIdstring

The ID of the request.

17D425C2-4EA3-4AB8-928D-E10511ECF***
Successboolean

Indicates whether the request is successful.

true

Example

Normal return example

JSONFormat

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "17D425C2-4EA3-4AB8-928D-E10511ECF***",
  "Success": true
}

Error codes

Http codeError codeError message
400WHITE.PARAM.ERROR%s. Please check and try again later.
400WHITE.OVER.LENGTH.ERROR%s. Please check and try again later.
400WHITE.IPLIST.OVERLONG.ERROR%s. Please check and try again later.
400WHITE.IP.ILLEGAL.ERROR%s. Please check and try again later.
400WHITE.IP.ALREADY.EXISTS.ERROR%s. Please check and try again later.
400WHITE.DELETE.ERROR%s. Please check and try again later.

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
2022-09-20The error codes of the API operation has changed, The input parameters of the API operation has changed
Change itemChange content
Error CodesThe error codes of the API operation has changed
    Added Error Codes: 400
Input ParametersThe input parameters of the API operation has changed
    Added Input Parameters: Description