All Products
Search
Document Center

ApsaraMQ for Kafka:GetAllowedIpList

Last Updated:Mar 15, 2024

Queries the IP address whitelist.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
alikafka:ListInstanceRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
InstanceIdstringYes

The instance ID.

alikafka_post-cn-mp91inkw****

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

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

200
Messagestring

The message returned.

operation success.
RequestIdstring

The ID of the request.

A421CCD7-5BC5-4B32-8DD8-64668A8FCB56
Successboolean

Indicates whether the request is successful.

true
AllowedListobject

The IP address whitelist.

DeployTypeinteger

The deployment mode of the instance. Valid values:

  • 4: allows access from the Internet and a virtual private cloud (VPC).
  • 5: allows access from a VPC.
Note Only integrators need to concern themselves with the value of this parameter.
4
VpcListobject []

The whitelist for access from a virtual private cloud (VPC).

PortRangestring

The port range. Valid value:

9092/9092.

9092/9092
AllowedIpListarray

The information about the IP address whitelist.

string

The IP address whitelist.

192.XX.XX.XX/XX
AllowedIpGroupobject

The group to which the IP address whitelist belongs.

string

The IP address whitelist.

192.XX.XX.XX/XX
InternetListobject []

The whitelist for access from the Internet.

PortRangestring

The port range. Valid value:

9093/9093.

9093/9093
AllowedIpListarray

The information about the IP address whitelist.

string

The IP address whitelist.

0.0.0.0/0
AllowedIpGroupobject

The group to which the IP address whitelist belongs.

string

The IP address whitelist.

0.0.0.0/0

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "A421CCD7-5BC5-4B32-8DD8-64668A8FCB56",
  "Success": true,
  "AllowedList": {
    "DeployType": 4,
    "VpcList": [
      {
        "PortRange": "9092/9092",
        "AllowedIpList": [
          "192.XX.XX.XX/XX"
        ],
        "AllowedIpGroup": {
          "key": "192.XX.XX.XX/XX"
        }
      }
    ],
    "InternetList": [
      {
        "PortRange": "9093/9093",
        "AllowedIpList": [
          "0.0.0.0/0"
        ],
        "AllowedIpGroup": {
          "key": "0.0.0.0/0"
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-09-20The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.