All Products
Search
Document Center

Security Center:AddCloudVendorAccountAK

Last Updated:Aug 30, 2024

Adds the configuration information of multi-cloud assets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:AddCloudVendorAccountAKcreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VendorstringYes

The cloud service provider. Valid values:

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

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

  • primary: a primary account
  • sub: a sub-account
primary
SecretIdstringYes

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****
SecretKeystringYes

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****
RegionsarrayNo

The regions that are examined during AccessKey pair authentication. This parameter takes effect only when Vendor is set to AWS.

stringNo

The region that is examined during AccessKey pair authentication.

ap-south-1
SubscriptionIdsarrayNo

The subscription IDs. This parameter takes effect only when Vendor is set to Azure.

stringNo

The subscription ID.

9b41e7ae-fcbf-4983-aa32-6fb2e*****
TenantIdstringNo

The tenant ID. This parameter takes effect only when Vendor is set to Azure.

95304a97-339b-4de5-9a7d-cdbffaf****
DomainstringNo

The Active Directory (AD) domain. This parameter takes effect only when Vendor is set to Azure. Valid values:

  • china
  • global
global
AuthModulesarrayNo

The modules that are associated with the AccessKey pair.

stringNo

The code of the module. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

A60DA4EC-7CD8-577D-AD73-***
Dataobject

The information about the AccessKey pair that is added.

Statusinteger

The status of the AccessKey pair. Valid values:

  • 0: enabled
  • 1: disabled
0
AuthIdlong

The unique ID of the AccessKey pair.

2158
AkTypestring

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

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

The AccessKey ID.

AE6SLd****
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: 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.

object
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

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 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.