Modifies the configuration of the AccessKey pair for a third-party account.
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:ModifyCloudVendorAccountAK | update | *All Resources * |
| none |
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:
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 |
| 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:
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:
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:
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 |
| 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
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 |
