DescribeSoarRecordInOutput - Security Center - Alibaba Cloud Documentation Center

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:DescribeSoarRecordInOutput

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ActionUuid	string	Yes	The UUID of the component action. Note Call the DescribeSoarTaskAndActions API to get this parameter.	0531ff66-dd05-4f24-84bf-xxxxxxxx
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.	372D8B41-AF8D-573A-9B3F-0924950F241F
InOutputInfo	string	The execution result of the component action.	{ "actionUuid": "3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx", "outputSummary": { "datalist": [ { "a": "a" } ], "total_data_successful": 1, "total_data": 1, "total_exe_successful": 1, "total_exe": 1, "total_data_with_dup": 1, "status": true }, "outputSchema": { "a": "String", "startTime": "DateTime" }, "inputParams": { "inputData": [ { "outputFields": { "a": "a" } } ], "totalSize": 1 }, "startTime": "2023-11-13 17:47:28.645", "taskName": "92af3c79-1754-4646-9366-9ddbxxxxx" }

InOutputInfo is a JSON string that contains the following fields:

actionUuid: The UUID of the component action execution record.
startTime: The time when the component action started.
taskName: The name of the playbook task that corresponds to the component action.
outputSchema: The metadata of the action's output data. This is in JSON format and is defined during playbook orchestration.
outputSummary: The output parameters of the action. This is in JSON format and contains the following fields:
- datalist: The details of the output data.
- total_data_successful: The number of successfully executed data entries.
- total_data: The total number of data entries.
- total_exe_successful: The number of successful executions.
- total_exe: The total number of executions.
- total_data_with_dup: The number of duplicate data entries.
- status: Indicates whether the execution was successful. true indicates success, and false indicates failure.
inputParams: The input data for the action. This is in JSON format and contains the following fields:
- inputData: The specific input data for the action.
- totalSize: The number of input data entries for the action.

Examples

Success response

JSON format

{
  "RequestId": "372D8B41-AF8D-573A-9B3F-0924950F241F",
  "InOutputInfo": "{\n    \"actionUuid\": \"3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx\",\n    \"outputSummary\": {\n        \"datalist\": [\n            {\n                \"a\": \"a\"\n            }\n        ],\n        \"total_data_successful\": 1,\n        \"total_data\": 1,\n        \"total_exe_successful\": 1,\n        \"total_exe\": 1,\n        \"total_data_with_dup\": 1,\n        \"status\": true\n    },\n    \"outputSchema\": {\n        \"a\": \"String\",\n        \"startTime\": \"DateTime\"\n    },\n    \"inputParams\": {\n        \"inputData\": [\n            {\n                \"outputFields\": {\n                    \"a\": \"a\"\n                }\n            }\n        ],\n        \"totalSize\": 1\n    },\n    \"startTime\": \"2023-11-13 17:47:28.645\",\n    \"taskName\": \"92af3c79-1754-4646-9366-9ddbxxxxx\"\n}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.