ModifyCloudVendorAccountAK - Security Center - Alibaba Cloud Documentation Center

Modifies the configuration of the AccessKey pair for a third-party account.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
AuthIds	string	Yes	The unique ID of the AccessKey pair. Note You can call the DescribeCloudVendorAccountAKList operation to query the unique ID.	2832
SecretId	string	No	ID of the AK parameter. Values: When AkType is primary: Tencent: AccessKeyId of the main account HUAWEICLOUD: AccessKeyId of the main account Azure: ClientId AWS: AccessKeyId of the main account VOLCENGINE: AccessKeyId of the main account When AkType is sub: Tencent: AccessKeyId of the sub-account HUAWEICLOUD: AccessKeyId of the sub-account Azure: ClientId AWS: AccessKeyId of the sub-account VOLCENGINE: AccessKeyId of the sub-account google: private_key_id Note If AkType is primary, this value is the SecretID of the main account from another cloud. If AkType is sub, this value is the Access Key ID of the sub-account from another cloud. For Azure, there is no distinction, and this value is the appId of the authentication information. Google Cloud is accessed through a service account, with AkType defaulting to sub, and this value is taken from the private_key_id attribute in the JSON format service key file.	S3D6c4O***
SecretKey	string	No	The AccessKey secret. Note If AkType is set to primary, you must set SecretKey to the AccessKey secret of the third-party master account. If AkType is set to sub, you must set SecretKey to the AccessKey secret of the third-party sub-account. This parameter value does not change for a Microsoft Azure account. For an Azure account, set this parameter to the password that is used for authentication.	AE6SLd****
Regions	array	No	The regions that are examined during AccessKey pair authentication.
regions	string	No	The region that is examined during AccessKey pair authentication. Note This parameter takes effect only when Vendor is set to AWS. You can call the ListCloudVendorRegions operation to query regions.	ap-south-1
Status	integer	No	The status of the AccessKey pair. Valid values: 0: enabled. 1: disabled.	0
TenantId	string	No	The tenant ID. Note This parameter takes effect only when Vendor is set to Azure.	95304a97-339b-4de5-9a7d-cdbffaf****
SubscriptionIds	array	No	The IDs of subscriptions. Note This parameter takes effect only when Vendor is set to Azure.
	string	No	The ID of the subscription. Note This parameter takes effect only when Vendor is set to Azure.	9b41e7ae-fcbf-4983-aa32-6fb2e*****
Domain	string	No	Access account domain. Values: china: China global: Global europe: Huawei Europe Note This parameter is only valid and required for Vendor being HUAWEICLOUD, Azure, AWS, or VOLCENGINE.	global
AuthModules	array	No	The modules that are associated with the AccessKey pair. Valid values: HOST: host. CSPM: configuration assessment. SIEM: Cloud Threat Detection and Response (CTDR). TRIAL: log audit. Note You can call the GetSupportedModules operation to query the supported modules.
	string	No	The module that is associated with the AccessKey pair. Valid values: HOST: host. CSPM: configuration assessment. SIEM: CTDR. TRIAL: log audit. Note You can call the GetSupportedModules operation to query the supported modules.	HOST
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 AccessKey pair. Note The account information of the third-party cloud servers.	test
ExtendInfo	string	No	Extended information. Note Used to record extended information from different vendors. For Google Cloud, which is accessed through a service account, ExtendInfo stores a JSON-formatted service key file, excluding the private_key_id and zprivate_key fields. The file includes the following fields: type, project_id, client_email, client_id, auth_uri, token_uri, auth_provider_x509_cert_url, client_x509_cert_url, universe_domain.	{\"product\":\"webFirewall\",\"remark\":\"remark\"}
CtdrCloudUserId	string	No	Account ID. Note The account ID of the connected cloud vendor, required when the permission description includes threat analysis and response.	azure_demo_1

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	6635CED5-4B20-5D2D-94EC-A1C8F9C****
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 sub	sub
SecretId	string	The AccessKey ID. Note If AkType is set to primary, the value of SecretId is AccessKey ID of the third-party master account. If AkType is set to sub, the value of SecretId is the AccessKey ID of the third-party sub-account. This parameter value does not change for a Microsoft Azure account. For an Azure account, this parameter value is the app ID that is used for authentication.	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 type of the cloud asset. Valid values: Tencent: Tencent Cloud. HUAWEICLOUD: Huawei Cloud. Azure: Microsoft Azure. AWS: Amazon Web Services (AWS). VOLCENGINE: Volcengine google: Google Cloud CHAITIN: Chaitin Tech FORTINET: Fortinet THREATBOOK: ThreatBook	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	The module that is associated with the AccessKey pair.
ModuleDisp	string	The display name of the module.	Host
ModuleStatement	string	The permission description of the module.	Host
Module	string	The code of the module. Valid values: HOST: host. CSPM: configuration assessment. SIEM: CTDR. TRIAL: log audit.	HOST
ModuleAssetType	string	The type of the cloud asset that is associated with the module.	Module.
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
VendorAuthAlias	string	The name of the AccessKey pair. Note The account information of the third-party cloud servers.	test
CtdrCloudUserId	string	Account ID. Note The account ID of the cloud provider being connected.	azure_demo_1

Examples

Sample success responses

JSONformat

{
  "RequestId": "6635CED5-4B20-5D2D-94EC-A1C8F9C****",
  "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",
        "ModuleStatement": "Host",
        "Module": "HOST",
        "ModuleAssetType": "Module.",
        "ModuleServiceStatus": 0,
        "Message": "ak_domain_error"
      }
    ],
    "VendorAuthAlias": "test",
    "CtdrCloudUserId": "azure_demo_1"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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 request parameters of the API has changed	View Change Details