All Products
Search
Document Center

Message Queue for Apache Kafka:GetAllowedIpList

Last Updated:Nov 01, 2022

Queries the IP address allowlist of a Message Queue for Apache Kafka instance.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
alikafka:ListInstanceRead
      without
    without

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the instance.

    cn-hangzhou
    InstanceIdstringYes

    The ID of the instance.

    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 returned message.

    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 allowlist of the instance.

    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.
    NoteOnly integrators need to concern themselves with the value of this parameter.
    4
    VpcListarray

    The allowlist for access from a VPC.

    object
    PortRangestring

    The port range. Valid values:

    9092/9092.

    9092/9092
    AllowedIpListarray
    string

    The IP address allowlist of the instance.

    192.XXX.X.X/XX
    InternetListarray

    The allowlist for access from the Internet.

    object
    PortRangestring

    The port range. Valid values:

    9093/9093.

    9093/9093
    AllowedIpListarray
    string

    The IP address allowlist of the instance.

    0.0.0.0/0

    Example

    Request example

    http(s)://[Endpoint]/?Action=GetAllowedIpList
    &RegionId=cn-hangzhou
    &InstanceId=alikafka_post-cn-mp91inkw****
    &<Common request parameters>
    

    Normal return example

    JSONFormat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperate
    2022-09-20The response structure of the API operation has changed
    Change itemChange content
    Output ParametersThe response structure of the API operation has changed