DescribeSophonCommands - Security Center - Alibaba Cloud Documentation Center

Queries the commands that are used to manage entities.

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

yundun-sas:DescribeSophonCommands

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the command. Fuzzy search is supported.	waf_process

Response elements

Element	Type	Description	Example
	object	The returned information.
Data	array<object>	The list of returned commands.
	array<object>	The details of the command.
Name	string	The name of the command.	waf_process_ip_v2
DisplayName	string	The display name of the command.	WAF Process IP
ParamConfig	array<object>	The parameter settings.
	object	The parameter settings.
Necessary	boolean	Indicates whether the parameter is required. Valid values: true: The parameter is required. This is the default value. false: The parameter is optional.	true
Field	string	The name of the parameter field.	ip
Value	string	The value of the parameter.	12.xx.xx.xx
CheckField	string	The regular expression that is used to check the format of the field. If this parameter is empty, no check is performed.	[0-9]{4}\.[0-9]{4}\.[0-9]{4}\.[0-9]{4}
Description	string	The description of the command.	This is a action of processing for WAF
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot and locate issues.	1E1EC464-3BD7-518F-9937-BCC12E6855FE

Examples

Success response

JSON format

{
  "Data": [
    {
      "Name": "waf_process_ip_v2",
      "DisplayName": "WAF Process IP",
      "ParamConfig": [
        {
          "Necessary": true,
          "Field": "ip",
          "Value": "12.xx.xx.xx",
          "CheckField": "[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}"
        }
      ],
      "Description": "This is a action of processing for WAF"
    }
  ],
  "RequestId": "1E1EC464-3BD7-518F-9937-BCC12E6855FE"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.