DescribeCloudVendorAccountAKList API Overview - Security Center

Lists multi-cloud asset configurations.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries to return on each page. Default value: 20.	20
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
SubAccountName	string	No	The username of the sub-account that is associated with the AccessKey pair.	AlibabaCloud_***
Status	integer	No	The status of the AccessKey pair. Valid values: 0: enabled 1: disabled	1
AuthIds	string	No	The unique ID of the AccessKey pair.	2624
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
VendorAuthAlias	string	No	The name of the account that is associated with the AccessKey pair.	test
Vendor	string	No	The vendor of the cloud asset. Valid values: Tencent: Tencent Cloud AWS: Amazon Web Services (AWS)	VOLCENGINE

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	1383B0DB-D5D6-4B0C-9E6B-75939C8****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	55
Count	integer	The number of entries on the current page.	20
CloudVendorAccountAKs	array<object>	The details of the AccessKey pairs.
	array<object>
Status	integer	The status of the AccessKey pair. Valid values: 0: enabled 1: disabled	0
AuthId	integer	The unique ID of the AccessKey pair.	2345
AkType	string	The type of the account to which the AccessKey pair belongs. Valid values: primary: primary account sub: RAM user	primary
SecretId	string	The AccessKey ID.	S3D6c4O***
ServiceStatus	integer	The status of the AccessKey pair. Valid values: 0: in use 1: abnormal 2: being verified 3: verification timed out	0
Vendor	string	The cloud service provider. Valid values: Tencent: Tencent Cloud HUAWEICLOUD: HUAWEI CLOUD Azure: Azure AWS: AWS VOLCENGINE: Volcengine google: Google Cloud CHAITIN: Chaitin Tech FORTINET: Fortinet THREATBOOK: ThreatBook	Tencent
Message	string	The error message for the AccessKey pair.	The IAM user is forbidden in the currently selected region
AuthModules	array<object>	The modules associated with the AccessKey pair.
	object
ModuleDisp	string	The display name of the module.	Host Assets
ModuleStatement	string	The description of the permissions required for the module.	Read permission of the cloud server or virtual machine
Module	string	The code of the module. Valid values: HOST: Host CSPM: Cloud Security Posture Management SIEM: CloudSiem TRIAL: Log Audit	HOST
ModuleAssetType	string	The type of cloud assets associated with the module.	Cloud server or virtual machine
ModuleServiceStatus	integer	The status of the module. Valid values: 0: in use 1: abnormal 2: being verified 3: verification timed out	0
Message	string	The error message for the module.	ak_domain_error
TrailStatus	string	The status of Log Audit. Valid values: init: initializing verify: verifying enable: enabled disable: disabled error: abnormal timeout: verification timed out	enable
TrailMessage	string	The error message that is returned when Log Audit fails to be enabled.	timeout
VendorAuthAlias	string	The name of the account to which the AccessKey pair belongs.	test
CtdrCloudUserId	string	The ID of the account. Note The account ID of the cloud service provider.	azure_demo_1
ExtendInfo	string	The extended information. Note This parameter is used to record the extended information of different cloud service providers. For a Google Cloud account that is added by using a service account, the ExtendInfo parameter stores the service key file in the JSON format, excluding the private_key_id and private_key fields. The file contains the following fields: type, project_id, client_email, client_id, auth_uri, token_uri, auth_provider_x509_cert_url, client_x509_cert_url, and universe_domain.	{\"product\":\"webFirewall\",\"remark\":\"remark\"}
VendorUid	string	The account ID of the multi-cloud instance.	123
VendorUserName	string	The account name of the multi-cloud instance.	VendorUserName

Examples

Success response

JSON format

{
  "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"
        }
      ],
      "VendorAuthAlias": "test",
      "CtdrCloudUserId": "azure_demo_1",
      "ExtendInfo": "{\\\"product\\\":\\\"webFirewall\\\",\\\"remark\\\":\\\"remark\\\"}",
      "VendorUid": "123",
      "VendorUserName": "VendorUserName"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.