All Products
Search
Document Center

Lindorm:GetInstanceIpWhiteList

Last Updated:May 31, 2024

Queries the whitelists configured for a Lindorm instance.

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
lindorm:GetInstanceIpWhiteListREAD
  • instance
    acs:lindorm:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance whose whitelists you want to query. You can call the GetLindormInstanceList operation to obtain the instance ID.

ld-bp1z3506imz2f****

Response parameters

ParameterTypeDescriptionExample
object
InstanceIdstring

The ID of the Lindorm instance.

ld-bp1z3506imz2f****
RequestIdstring

The ID of the request.

1D1F6F4D-9203-53E7-84E9-5376B4657E63
IpListarray
string

The list of IP addresses in the whitelist of the instance.

192.168.0.0/24
GroupListobject []

The details about the IP address whitelists.

GroupNamestring

The name of the IP address whitelist.

test
SecurityIpListstring

The IP addresses in the whitelist.

192.168.1.0/24

Examples

Sample success responses

JSONformat

{
  "InstanceId": "ld-bp1z3506imz2f****",
  "RequestId": "1D1F6F4D-9203-53E7-84E9-5376B4657E63",
  "IpList": [
    "192.168.0.0/24"
  ],
  "GroupList": [
    {
      "GroupName": "test",
      "SecurityIpList": "192.168.1.0/24"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400Lindorm.Errorcode.ParameterInvaildThe parameter is invalid.-
400Instance.IsDeletedThe instance is deleted.The specified instance is already deleted.
400Instance.IsNotValidThe instance is invalid.The specified instance is invalid.
403Lindorm.Errorcode.OperationDeniedYou are not authorized to operate on the specified resource.-
403API.ForbiddenThe API operation is forbidden in this environment.This operation is not supported in the current environment.

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

Change history

Change timeSummary of changesOperation
2023-10-10The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Output ParametersThe response structure of the API has changed.
2023-09-11The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: GroupName