ModifyCloudVendorAccountAK - 修改多云资产授权配置信息

修改多云资产授权认证配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:ModifyCloudVendorAccountAKupdate
*全部资源
*

请求参数

名称类型必填描述示例值
AuthIdsstring

AK 唯一 ID。

说明 调用 DescribeCloudVendorAccountAKList 接口可以获取该参数。
2832
SecretIdstring

AK 参数 Id。取值:

1.AkType 取值 primary:

  • Tencent:主账号 AccessKeyId
  • HUAWEICLOUD:主账号 AccessKeyId
  • Azure:ClientId
  • AWS:主账号 AccessKeyId
  • VOLCENGINE:主账号 AccessKeyId

2.AkType 取值 sub:

  • Tencent:子账号 AccessKeyId
  • HUAWEICLOUD:子账号 AccessKeyId
  • Azure:ClientId
  • AWS:子账号 AccessKeyId
  • VOLCENGINE:子账号 AccessKeyId
  • google:private_key_id
说明 AkType 取值为 primary 则该值为他云的主账号 SecretID。AkType 取值为 sub 则该值为他云子账号 Access Key ID。Azure 不做区分,该值为认证信息的 appId。谷歌云是通过服务账号接入的,AkType 默认取值 sub, 该值取自 JSON 格式服务密钥文件的 private_key_id 属性值。
S3D6c4O***
SecretKeystring

AK 参数 Secret。

说明 AkType 取值为 primary 则该值为他云的主账号 Secret Access Key。AkType 取值为 sub 则该值为他云子账号 Secret Access Key。Azure 不做区分,该值为认证信息的 password。谷歌云是通过服务账号接入的,AkType 默认取值 sub, 该值取自 JSON 格式服务密钥文件的 private_key 属性值。
AE6SLd****
Regionsarray

AK 信息验证所使用的 Region 列表。

regionsstring

AK 信息验证所使用的 Region。

说明 该参数仅对 Vendor 为 AWS 有效。您可调用 ListCloudVendorRegions 接口可以获取该参数。
ap-south-1
Statusinteger

AK 使用状态。取值:

  • 0:启用
  • 1:停用
0
TenantIdstring

租户 ID。

说明 该参数仅对 Vendor 为 Azure 有效。
95304a97-339b-4de5-9a7d-cdbffaf****
SubscriptionIdsarray

订阅 ID 列表。

说明 该参数已无效。
string

订阅 ID。

说明 该参数已无效。
9b41e7ae-fcbf-4983-aa32-6fb2e*****
Domainstring

接入账号域。取值:

  • china:中国
  • global:全球
  • europe:华为欧洲站
说明 该参数仅对 VendorHUAWEICLOUDAzureAWSVOLCENGINE 有效,且为必传。
global
AuthModulesarray

AK 关联模块 Code 列表。取值:

  • HOST:主机
  • CSPM:云产品配置检查
  • SIEM:威胁分析与响应
  • TRIAL:日志审计
说明 您可调用 GetSupportedModules 接口获取可支持的模块。
string

AK 关联模块 Code。取值:

  • HOST:主机
  • CSPM:云产品配置检查
  • SIEM:威胁分析与响应
  • TRIAL:日志审计
说明 您可调用 GetSupportedModules 接口获取可支持的模块。
HOST
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
zh
VendorAuthAliasstring

AK 账号名称。

说明 用于标识三方主机资产的所属账号信息。
test
ExtendInfostring

扩展信息。

说明 用于记录不同厂商扩展信息。 谷歌云是通过服务账号接入的,ExtendInfo 存储的是 json 格式服务密钥文件,排除了 private_key_id 和 zprivate_key 字段。文件中包含字段: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\"}
CtdrCloudUserIdstring

账号 ID。

说明 接入的云厂商的账号 ID,当权限说明包含威胁分析与响应时必填。
azure_demo_1

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

6635CED5-4B20-5D2D-94EC-A1C8F9C****
Dataobject

当前添加授权认证信息。

Statusinteger

AK 使用状态。取值:

  • 0:启用
  • 1:停用
0
AuthIdlong

AK 唯一 ID。

2158
AkTypestring

AK 账号类型。取值:

  • primary:主账号
  • sub:子账号
sub
SecretIdstring

AK 参数 ID。

说明 AkType 取值为 primary 则该值为他云的主账号 SecretID。AkType 取值为 sub 则该值为他云子账号 Access Key ID。Azure 不做区分,该值为认证信息的 appId
AE6SLd****
ServiceStatusinteger

AK 可用状态。取值:

  • 0:使用中
  • 1:使用异常
  • 2:有效性验证中
  • 3:有效性验证超时
0
Vendorstring

云资产厂商。取值:

  • Tencent:腾讯云
  • HUAWEICLOUD:华为云
  • Azure:Azure
  • AWS:AWS
  • VOLCENGINE:火山云
  • google:谷歌云
  • CHAITIN:长亭科技
  • FORTINET:飞塔
  • THREATBOOK:微步在线
Tencent
Messagestring

AK 异常信息。

The IAM user is forbidden in the currently selected region
AuthModulesarray<object>

AK 关联模块信息列表。

AuthModuleobject

认证授权关联模块信息。

ModuleDispstring

模块显示名称。

Host Assets
ModuleStatementstring

模块关联权限说明。

Read permission of the cloud server or virtual machine
Modulestring

模块 Code。取值:

  • HOST:主机
  • CSPM:云产品配置检查
  • SIEM:威胁分析与响应
  • TRIAL:日志审计
HOST
ModuleAssetTypestring

模块关联云资产说明。

Cloud server or virtual machine
ModuleServiceStatusinteger

模块状态。取值:

  • 0:使用中
  • 1:使用异常
  • 2:有效性验证中
  • 3:有效性验证超时
0
Messagestring

模块异常信息。

ak_domain_error
VendorAuthAliasstring

AK 账号名称。

说明 用于标识三方主机资产的所属账号信息。
test
CtdrCloudUserIdstring

账号 ID。

说明 接入的云厂商的账号 ID。
azure_demo_1

示例

正常返回示例

JSON格式

{
  "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 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"
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-10-30OpenAPI 入参发生变更查看变更详情