Adds the configuration information of multi-cloud assets.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Vendor | string | Yes | The cloud service provider. Valid values:
| AWS |
| AkType | string | Yes | The type of the account to which the AccessKey pair belongs. Valid values:
| primary |
| SecretId | string | Yes | The AccessKey ID. Valid values: 1. If AkType is set to primary, specify this parameter based on the following description:
2. If AkType is set to sub, specify this parameter based on the following description:
| 45GLRV4SOT0YFB**** |
| SecretKey | string | Yes | The AccessKey secret. Valid values: 1. If AkType is set to primary, specify this parameter based on the following description:
2. If AkType is set to sub, specify this parameter based on the following description:
| AE6SLd**** |
| Regions | array | No | The regions that are examined during AccessKey pair authentication. This parameter takes effect only when Vendor is set to AWS. Note
You can call the ListCloudVendorRegions operation to query regions.
| |
| 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:
| global |
| AuthModules | array | No | The modules that are associated with the AccessKey pair. | |
| string | No | The code of the module. Valid values:
| HOST | |
| Lang | string | No | The language of the content in the request and response messages. Default value: zh. Valid values:
| 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 via a service account, ExtendInfo stores the service key file in JSON format, 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. > The account ID of the cloud provider, required when permissions include threat analysis and response. | azure_demo_1 |
Response parameters
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"
}
],
"VendorAuthAlias": "test",
"CtdrCloudUserId": "azure_demo_1"
}
}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 |