DescribeSecurityIPGroup API & Cross-Product Whitelist Templates - DAS

Views the details of a cross-product whitelist template.

Operation description

Note the following before you call this operation:

Use the latest version of the Alibaba Cloud software development kit (SDK) or DAS 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:DescribeSecurityIPGroup

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionName	string	Yes	The region ID.	cn-shanghai

Response elements

Element	Type	Description	Example
	object	The response schema.
Code	string	The status code returned.	200
Data	object	ListResult
SecurityIpGroups	array<object>	A list of all cross-product whitelist templates in the specified region.
	array<object>
DbInstances	array	The database instances that are attached to the whitelist template.
	string	The database instance ID.	["r-2ze9g6mnhu1*", "pc-2zew5qn1m", "r-2ze9g6mn*", "pc-2zew5qh41***"]
SecurityIpType	string	The IP address type.	ipv4
Uid	string	The account ID. You can obtain the ID of your logon account on the Security Settings page of Account Management.	160-79abe3f4****
RegionId	string	The region ID.	cn-hangzhou
GEcsSgIdList	string	The ID of the ECS security group. This parameter is deprecated and is retained for compatibility. It will be removed in a future version.	null
GlobalIgName	string	The name of the IP address whitelist template. The name must meet the following requirements: It must consist of lowercase letters, digits, and underscores (_). It must start with a letter and end with a letter or a digit. It must be 2 to 120 characters in length.	test_123
GlobalSecurityGroupId	string	The ID of the IP address whitelist template.	g-1no2rzybnqcv****
WhitelistNetType	string	The network type of the whitelist.	mix
EngineInfoList	array<object>	The information about the instances of each product that are attached to the template.
	object
InstanceNum	integer	The number of instances that belong to the current logon account.	10
EngineName	string	The database type of the destination instance.	PolarDBMySQL
InstanceIds	array	A list of database instance IDs.
	string	The database instance ID. Note The value is a JSON array, such as `['Instance ID1','Instance ID2']`. Separate multiple instance IDs with commas (,).	rm-2ze8ygcc****
UserId	string	The user ID.	641***
GIpList	string	The IP addresses in the whitelist template. Note Separate multiple IP addresses with commas (,).	192.168.1.28/32
Message	string	The message returned for the request. 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.	CAC553F1-C669-53F1-A295-2CF050E****
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": {
    "SecurityIpGroups": [
      {
        "DbInstances": [
          "[\"r-2ze9g6mnhu1***\",\n\"pc-2zew5qn1m***\",\n\"r-2ze9g6mn****\",\n\"pc-2zew5qh41*****\"]"
        ],
        "SecurityIpType": "ipv4",
        "Uid": "160-79abe3f4****",
        "RegionId": "cn-hangzhou",
        "GEcsSgIdList": " null",
        "GlobalIgName": "test_123",
        "GlobalSecurityGroupId": "g-1no2rzybnqcv****",
        "WhitelistNetType": "mix",
        "EngineInfoList": [
          {
            "InstanceNum": 10,
            "EngineName": "PolarDBMySQL",
            "InstanceIds": [
              "rm-2ze8ygcc****"
            ]
          }
        ],
        "UserId": "641***",
        "GIpList": "192.168.1.28/32"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "CAC553F1-C669-53F1-A295-2CF050E****",
  "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.