Use GetStandardGroup to query security rule set information - Data Management - Alibaba Cloud - Data Management

Queries the security rule sets of a tenant, including rule names, descriptions, and associated instance types.

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

dms:GetStandardGroup

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	integer	Yes	The security rule set ID. You can call the ListStandardGroups operation to obtain the ID of the security rule set.	242***
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, log on to the DMS console and hover over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	23****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	BF7E9543-F431-566A-991A-B5C493EA36C3
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
StandardGroup	object	The information about the security rule set.
GroupName	string	The name of the security rule set.	poc_test
Description	string	The description of the security rule set.	Test rules for the production environment
DbType	string	The engine type.	mysql
LastMenderId	integer	The ID of the user who last modified the security rules.	513***
GroupMode	string	The control mode. Valid values: NONE_CONTROL: Flexible Management STABLE: Stable Change COMMON: Security Collaboration	COMMON
GroupId	integer	The ID of the security rule set.	41****

Examples

Success response

JSON format

{
  "RequestId": "BF7E9543-F431-566A-991A-B5C493EA36C3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError\n",
  "StandardGroup": {
    "GroupName": "poc_test",
    "Description": "Test rules for the production environment",
    "DbType": "mysql",
    "LastMenderId": 0,
    "GroupMode": "COMMON",
    "GroupId": 0
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.