Skip to main content

List Access Credentials

List cloud access credentials with pagination. This API requires data source module permissions.

Endpoint: /openapi/v1/access/list

Method: GET

Request parameters

ParameterTypeRequiredDescription
nameStringNoCredential name keyword.
typeStringNoCredential type: accessKey or role.
vendorStringNoCloud vendor.
currentIntegerNoCurrent page number, starting at 1. Default: 1.
pageSizeIntegerNoRecords per page. Default: 10; maximum: 1000.

Response parameters

ParameterTypeDescription
successBooleanWhether the request succeeded.
requestIdStringRequest ID.
currentIntegerCurrent page.
pageSizeIntegerPage size.
totalIntegerTotal number of records.
dataArrayAccess credential details.
data[].accessIdStringAccess credential ID.
data[].nameStringCredential name.
data[].typeStringCredential type.
data[].vendorStringCloud vendor.
data[].accessKeyStringAccessKey ID.
data[].accessKeySecretStringAlways returned as null.
data[].roleNameStringRole name.
data[].arnStringRole ARN.
data[].statusStringnormal, invalid, or deleted.
data[].errorMessageStringError message.
data[].creatorIdStringCreator account ID.
data[].createTimeDateTimeCreation time.
data[].updateTimeDateTimeLast update time.

Success response

{
"success": true,
"requestId": "<requestId>",
"current": 1,
"pageSize": 10,
"total": 1,
"data": [{
"accessId": "<accessId>",
"name": "example-access",
"type": "accessKey",
"vendor": "aliyun",
"accessKey": "<accessKey>",
"accessKeySecret": null,
"status": "normal"
}]
}