All Products
Search
Document Center

Security Center:ModifyCloudVendorAccountAK

Last Updated:Dec 17, 2024

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
AuthIdsstringYes

The unique ID of the AccessKey pair.

Note You can call the DescribeCloudVendorAccountAKList operation to query the unique ID.
2832
SecretIdstringNo

The AccessKey ID.

Note If AkType is set to primary, you must set SecretId to the AccessKey ID of the third-party master account. If AkType is set to sub, you must set SecretId to the AccessKey ID 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 app ID that is used for authentication.
S3D6c4O***
SecretKeystringNo

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

The regions that are 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.
regionsstringNo

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
StatusintegerNo

The status of the AccessKey pair. Valid values:

  • 0: enabled.
  • 1: disabled.
0
TenantIdstringNo

The tenant ID.

Note This parameter takes effect only when Vendor is set to Azure.
95304a97-339b-4de5-9a7d-cdbffaf****
SubscriptionIdsarrayNo

The IDs of subscriptions.

Note This parameter takes effect only when Vendor is set to Azure.
stringNo

The ID of the subscription.

Note This parameter takes effect only when Vendor is set to Azure.
9b41e7ae-fcbf-4983-aa32-6fb2e*****
DomainstringNo

The Active Directory (AD) domain. Valid values:

  • china
  • global
Note This parameter takes effect only when Vendor is set to Azure.
global
AuthModulesarrayNo

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

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
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English.
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

6635CED5-4B20-5D2D-94EC-A1C8F9C****
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
  • sub
sub
SecretIdstring

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****
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 type of the cloud asset. Valid values:

  • Tencent: Tencent Cloud.
  • HUAWEICLOUD: Huawei Cloud.
  • Azure: Microsoft Azure.
  • AWS: Amazon Web Services (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.

AuthModuleobject

The module that is associated with the AccessKey pair.

ModuleDispstring

The display name of the module.

Host
ModuleStatementstring

The permission description of the module.

Host
Modulestring

The code of the module. Valid values:

  • HOST: host.
  • CSPM: configuration assessment.
  • SIEM: CTDR.
  • TRIAL: log audit.
HOST
ModuleAssetTypestring

The type of the cloud asset that is associated with the module.

Module.
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": "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"
      }
    ]
  }
}

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.

Change history

Change timeSummary of changesOperation
2024-10-30The request parameters of the API has changedView Change Details