DescribeAccesskeyLeakList API Reference - Security Center - Alibaba Cloud - Security Center

Queries information about leaked AccessKey pairs in your assets.

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-aegis:DescribeAccesskeyLeakList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Status	string	No	The processing status of the leaked AccessKey information that you want to query. Valid values: pending: unprocessed dealed: processed.	pending
Query	string	No	The AccessKey ID that you want to query. Only exact match is supported.	yourAccessKeyID
StartTs	integer	No	The discovery time of the leaked information that you want to query. All AccessKey leak information discovered after this point in time is returned. This parameter is a UNIX timestamp. Unit: milliseconds.	1614155361489
PageSize	integer	Yes	The maximum number of entries per page for a paged query. The maximum value of PageSize is 100. The default number of entries per page is 20. If the PageSize parameter is left empty, 20 entries are returned by default. Note Do not leave PageSize empty.	20
CurrentPage	integer	Yes	The page number of the current page in a paged query. Default value: 1.	1
ResourceDirectoryAccountId	integer	No	The ID of the member account in the resource directory (Alibaba Cloud account). Note You can invoke the DescribeMonitorAccounts operation to obtain this parameter.	1232428423234****

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The page number of the current page in a paged query.	1
RequestId	string	The unique ID generated by Alibaba Cloud for the request.	B37C9052-A73E-4707-A024-9247702852BE
GmtLast	integer	This parameter is deprecated and can be ignored.	1612357897000
AkLeakCount	integer	The number of unprocessed AccessKey leak entries.	1
PageSize	integer	The maximum number of entries per page in a paged query.	20
TotalCount	integer	The total number of AccessKey leak entries returned.	2
AccessKeyLeakList	array<object>	The list of detailed information about leaked AccessKey pairs.
	object
DealTime	string	The time when the AccessKey leak information was processed.	2020-12-03 21:23:38
Status	string	The processing status of the leaked AccessKey information. Valid values: pending: unprocessed dealed: processed.	pending
Type	string	The type of the leak information. The value is fixed as AccessKey.	AccessKey
UserType	string	The type of the account to which the leaked AccessKey pair belongs. Valid values: master: Alibaba Cloud account ram: Resource Access Management (RAM) user.	master
AccesskeyId	string	The leaked AccessKey ID.	yourAccessKeyID
AliUserName	string	The name of the affected Alibaba Cloud account.	testAccountName
DealType	string	The method used to handle the AccessKey leak information. Valid values: pending: unprocessed manual: manually processed disable: disabled add-whitelist: added to the whitelist.	pending
Url	string	The URL of the external platform where the AccessKey leak was discovered.	https://github.com/hht312/test-ak/blob/0e466d2ecce55b4c924d773a058e5dc602d8****/1001
GmtModified	integer	The time when the AccessKey leak was first discovered. This parameter is a UNIX timestamp. Unit: milliseconds.	1612357897000
Asset	string	The platform where the asset resides. The value is fixed as Cloud Platform.	云平台
Id	integer	The primary key ID in the database.	389357

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "B37C9052-A73E-4707-A024-9247702852BE",
  "GmtLast": 1612357897000,
  "AkLeakCount": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "AccessKeyLeakList": [
    {
      "DealTime": "2020-12-03 21:23:38",
      "Status": "pending",
      "Type": "AccessKey",
      "UserType": "master",
      "AccesskeyId": "yourAccessKeyID",
      "AliUserName": "testAccountName",
      "DealType": "pending",
      "Url": "https://github.com/hht312/test-ak/blob/0e466d2ecce55b4c924d773a058e5dc602d8****/1001",
      "GmtModified": 1612357897000,
      "Asset": "云平台",
      "Id": 389357
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	no permission
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	RdCheckInnerError	Resource directory account service internal error.
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.