AddCloudVendorAccountAK - Security Center - Alibaba Cloud Documentation Center

Adds the configuration information of multi-cloud assets.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:AddCloudVendorAccountAK	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Vendor	string	Yes	The cloud service provider. Valid values: Tencent: Tencent Cloud HUAWEICLOUD: Huawei Cloud Azure: Microsoft Azure AWS: Amazon Web Services (AWS)	AWS
AkType	string	Yes	The type of the account to which the AccessKey pair belongs. Valid values: primary: a primary account sub: a sub-account	primary
SecretId	string	Yes	The AccessKey ID. Valid values: 1. If AkType is set to primary, specify this parameter based on the following description: Tencent: Enter the AccessKey ID of a primary account on Tencent Cloud. HUAWEICLOUD: Enter the AccessKey ID of a primary account on Huawei Cloud. Azure: Enter the AccessKey ID of a primary account on Microsoft Azure. AWS: Enter the AccessKey ID of a primary account on AWS. 2. If AkType is set to sub, specify this parameter based on the following description: Tencent: Enter the AccessKey ID of a sub-account on Tencent Cloud. HUAWEICLOUD: Enter the AccessKey ID of a sub-account on Huawei Cloud. Azure: Enter the AccessKey ID of a sub-account on Microsoft Azure. AWS: Enter the AccessKey ID of a sub-account on AWS.	45GLRV4SOT0YFB****
SecretKey	string	Yes	The AccessKey secret. Valid values: 1. If AkType is set to primary, specify this parameter based on the following description: Tencent: Enter the AccessKey secret of a primary account on Tencent Cloud. HUAWEICLOUD: Enter the AccessKey secret of a primary account on Huawei Cloud. Azure: Enter the AccessKey secret of a primary account on Microsoft Azure. AWS: Enter the AccessKey secret of a primary account on AWS. 2. If AkType is set to sub, specify this parameter based on the following description: Tencent: Enter the AccessKey secret of a sub-account on Tencent Cloud. HUAWEICLOUD: Enter the AccessKey secret of a sub-account on Huawei Cloud. Azure: Enter the AccessKey secret of a sub-account on Microsoft Azure. AWS: Enter the AccessKey secret of a sub-account on AWS.	AE6SLd****
Regions	array	No	The regions that are examined during AccessKey pair authentication. This parameter takes effect only when Vendor is set to AWS.
regions	string	No	The region that is examined during AccessKey pair authentication.	ap-south-1
SubscriptionIds	array	No	The subscription IDs. This parameter takes effect only when Vendor is set to Azure.
	string	No	The subscription ID.	9b41e7ae-fcbf-4983-aa32-6fb2e*****
TenantId	string	No	The tenant ID. This parameter takes effect only when Vendor is set to Azure.	95304a97-339b-4de5-9a7d-cdbffaf****
Domain	string	No	The Active Directory (AD) domain. This parameter takes effect only when Vendor is set to Azure. Valid values: china global	global
AuthModules	array	No	The modules that are associated with the AccessKey pair.
	string	No	The code of the module. Valid values: HOST: host CSPM: configuration assessment SIEM: CloudSiem TRIAL: log audit	HOST
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	A60DA4EC-7CD8-577D-AD73-***
Data	object	The information about the AccessKey pair that is added.
Status	integer	The status of the AccessKey pair. Valid values: 0: enabled 1: disabled	0
AuthId	long	The unique ID of the AccessKey pair.	2158
AkType	string	The type of the account to which the AccessKey pair belongs. Valid values: primary: a primary account sub: a sub-account	sub
SecretId	string	The AccessKey ID.	AE6SLd****
ServiceStatus	integer	The service status of the AccessKey pair. Valid values: 0: being used 1: exception occurred 2: being validated 3: validation timed out	0
Vendor	string	The cloud service provider. Valid values: Tencent: Tencent Cloud HUAWEICLOUD: Huawei Cloud Azure: Microsoft Azure AWS: AWS	Tencent
Message	string	The error message of the AccessKey pair.	The IAM user is forbidden in the currently selected region
AuthModules	array<object>	The modules that are associated with the AccessKey pair.
AuthModule	object
ModuleDisp	string	The display name of the module.	Host Assets
ModuleStatement	string	The permission description of the module.	Read permission of the cloud server or virtual machine
Module	string	The code of the module. Valid values: HOST: host CSPM: configuration assessment SIEM: CloudSiem TRIAL: log audit	HOST
ModuleAssetType	string	The cloud asset that is associated with the module.	Cloud server or virtual machine
ModuleServiceStatus	integer	The service status of the module. Valid values: 0: being used 1: exception occurred 2: being validated 3: validation timed out	0
Message	string	The error message of the module.	ak_domain_error

Examples

Sample success responses

JSONformat

{
  "RequestId": "A60DA4EC-7CD8-577D-AD73-***",
  "Data": {
    "Status": 0,
    "AuthId": 2158,
    "AkType": "sub",
    "SecretId": "AE6SLd****",
    "ServiceStatus": 0,
    "Vendor": "Tencent",
    "Message": "The IAM user is forbidden in the currently selected region",
    "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	CreateAkError	Failed to create an AK.	Failed to create an AK.
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2024-10-30	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-09-25	The Error code has changed	View Change Details