GetAttackPathWhitelist API Reference - Security Center - Alibaba Cloud - Security Center

Queries the details of an attack path whitelist.

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

get

*AttackPathWhitelist

acs:yundun-sas:{#regionId}:{#accountId}:attackpathwhitelist/{#AttackPathWhitelist}

None

Request parameters

Parameter	Type	Required	Description	Example
AttackPathWhitelistId	string	Yes	The attack path whitelist ID. Note You can call ListAttackPathWhitelist to query attack path whitelist IDs.	apwl-b33dec0acf9b42aabde032d656c0****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	D03DD0FD-6041-5107-AC00-383E28F1****
AttackPathWhitelist	object	The attack path whitelist.
AttackPathAssetList	array<object>	The list of cloud service assets in the attack path.
	object	The list of cloud service assets in the attack path.
AssetSubType	integer	Subtype of the cloud product asset.	0
AssetType	integer	Type of the cloud product asset.	1
InstanceId	string	Instance ID of the cloud product asset.	i-8vb0e8qdaj0yyxjo****
RegionId	string	Region ID of the cloud product asset instance.	cn-shanghai
Vendor	integer	Vendor of the cloud product asset.	0
InstanceName	string	Instance name.	xwl
NodeType	string	Node type, values: start: Start point. end: End point.	start
AttackPathWhitelistId	string	The attack path whitelist ID.	apwl-b33dec0acf9b42aabde032d656c0****
LastModifiedTimestamp	integer	The timestamp of the last modification, in milliseconds.	1743004587000
PathName	string	The path name.	ecs_get_credential_by_create_login_profile
PathType	string	The path type.	role_escalation
Remark	string	The remarks.	test
WhitelistType	string	The whitelist type. Valid values: ALL_ASSET: all assets. PART_ASSET: partial assets.	ALL_ASSET
WhitelistName	string	The whitelist name.	test

Examples

Success response

JSON format

{
  "RequestId": "D03DD0FD-6041-5107-AC00-383E28F1****",
  "AttackPathWhitelist": {
    "AttackPathAssetList": [
      {
        "AssetSubType": 0,
        "AssetType": 1,
        "InstanceId": "i-8vb0e8qdaj0yyxjo****\n",
        "RegionId": "cn-shanghai",
        "Vendor": 0,
        "InstanceName": "xwl",
        "NodeType": "start"
      }
    ],
    "AttackPathWhitelistId": "apwl-b33dec0acf9b42aabde032d656c0****\n",
    "LastModifiedTimestamp": 1743004587000,
    "PathName": "ecs_get_credential_by_create_login_profile",
    "PathType": "role_escalation",
    "Remark": "test",
    "WhitelistType": "ALL_ASSET",
    "WhitelistName": "test"
  }
}

Error codes

HTTP status code	Error code	Error message
400	DataNotExists	data not exist
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.