All Products
Search
Document Center

Database Autonomy Service:DescribeSecurityIPGroupRelation

Last Updated:Nov 21, 2025

Queries how cross-product whitelist templates are attached to instances.

Operation description

Before you call this operation, ensure that the following requirements are met:

  • Use the latest version of the Alibaba Cloud or DAS software development kit (SDK).

  • When you use an SDK to call the DAS service, set the region to cn-shanghai.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

RegionName

string

Yes

The region ID.

cn-shanghai

InstanceId

string

Yes

The instance ID.

rm-2zegsc57ofexxxxx

Response elements

Element

Type

Description

Example

object

Code

string

The HTTP status code that is returned.

200

Data

object

The data returned.

GlobalSecurityIPGroupRel

array<object>

The information about the global IP address whitelist template.

object

RegionId

string

The region ID.

cn-shenzhen

GlobalIgName

string

The name of the IP address whitelist template.

test2

GlobalSecurityGroupId

string

The ID of the IP address whitelist template.

g-1no2rzybnqcv0xxxxxx

GIpList

string

The IP addresses in the whitelist template.

Note

Separate multiple IP addresses with commas (,). Add a maximum of 1,000 IP addresses or CIDR blocks to all IP address whitelists.

192.168.1.28/32

InstanceId

string

The instance ID.

rm-2ze1jdv45i7l6****

Message

string

The returned message.

Note

If the request is successful, Successful is returned. If the request fails, an error message is returned, such as an error code.

Successful

RequestId

string

The request ID.

A6D1C8EE-013C-541F-83EB-B13C8xxxxxx

Success

string

Indicates whether the request was successful:

  • true: The request was successful.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": {
    "GlobalSecurityIPGroupRel": [
      {
        "RegionId": "cn-shenzhen",
        "GlobalIgName": "test2",
        "GlobalSecurityGroupId": "g-1no2rzybnqcv0xxxxxx",
        "GIpList": "192.168.1.28/32"
      }
    ],
    "InstanceId": "rm-2ze1jdv45i7l6****"
  },
  "Message": "Successful",
  "RequestId": "A6D1C8EE-013C-541F-83EB-B13C8xxxxxx",
  "Success": "true"
}

Error codes

HTTP status code

Error code

Error message

Description

400

InvalidParams

The request parameters are invalid.

403

NoPermission

You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.