All Products
Search
Document Center

Security Center:DescribeCloudVendorAccountAKList

Last Updated:Nov 13, 2024

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeCloudVendorAccountAKListlist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries per page. Default value: 20.

20
CurrentPageintegerNo

The page number. Default value: 1.

1
SubAccountNamestringNo

The username of the sub-account of the cloud service provider to which the AccessKey pair belongs.

AlibabaCloud_***
StatusintegerNo

The status of the AccessKey pair. Valid values:

  • 0: enabled
  • 1: disabled
1
AuthIdsstringNo

The unique ID of the AccessKey pair.

2624
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

1383B0DB-D5D6-4B0C-9E6B-75939C8****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

55
Countinteger

The number of entries returned on the current page.

20
CloudVendorAccountAKsarray<object>

The information about the AccessKey pairs.

CloudVendorAccountAKobject
Statusinteger

The status of the AccessKey pair. Valid values:

  • 0: enabled
  • 1: disabled
0
AuthIdlong

The unique ID of the AccessKey pair.

2345
AkTypestring

The type of the account to which the AccessKey pair belongs. Valid values:

  • primary: a primary account
  • sub: a sub-account
primary
SecretIdstring

The AccessKey ID.

S3D6c4O***
ServiceStatusinteger

The service status of the AccessKey pair. Valid values:

  • 0: being used
  • 1: exception occurred
  • 2: being validated
  • 3: validation timed out
0
Vendorstring

The cloud service provider. Valid values:

  • Tencent: Tencent Cloud
  • HUAWEICLOUD: Huawei Cloud
  • Azure: Microsoft Azure
  • AWS: Amazon Web Services (AWS)
Tencent
Messagestring

The error message of the AccessKey pair.

The IAM user is forbidden in the currently selected region
AuthModulesarray<object>

The modules that are associated with the AccessKey pair.

AuthModuleobject
ModuleDispstring

The display name of the module.

Host Assets
ModuleStatementstring

The permission description of the module.

Read permission of the cloud server or virtual machine
Modulestring

The code of the module. Valid values:

  • HOST: host
  • CSPM: configuration assessment
  • SIEM: CloudSiem
  • TRIAL: log audit
HOST
ModuleAssetTypestring

The cloud asset that is associated with the module.

Cloud server or virtual machine
ModuleServiceStatusinteger

The service status of the module. Valid values:

  • 0: being used
  • 1: exception occurred
  • 2: being validated
  • 3: validation timed out
0
Messagestring

The error message of the module.

ak_domain_error
TrailStatusstring

The status of the log audit service. Valid values:

  • init: being initialized
  • verify: being validated
  • enable: enabled
  • disable: disabled
  • error: exception occurred
  • timeout: validation timed out
enable
TrailMessagestring

The error message of the log audit service.

timeout

Examples

Sample success responses

JSONformat

{
  "RequestId": "1383B0DB-D5D6-4B0C-9E6B-75939C8****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 55,
    "Count": 20
  },
  "CloudVendorAccountAKs": [
    {
      "Status": 0,
      "AuthId": 2345,
      "AkType": "primary",
      "SecretId": "S3D6c4O***",
      "ServiceStatus": 0,
      "Vendor": "Tencent",
      "Message": "The IAM user is forbidden in the currently selected region\n",
      "AuthModules": [
        {
          "ModuleDisp": "Host Assets",
          "ModuleStatement": "Read permission of the cloud server or virtual machine",
          "Module": "HOST",
          "ModuleAssetType": "Cloud server or virtual machine",
          "ModuleServiceStatus": 0,
          "Message": "ak_domain_error",
          "TrailStatus": "enable",
          "TrailMessage": "timeout"
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-07-29The request parameters of the API has changedView Change Details