AddCloudVendorAccountAK - 新增多云资产授权配置

新增多云资产配置信息。

调试

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

授权信息

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

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

请求参数

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

云资产厂商。取值:

  • Tencent:腾讯云
  • HUAWEICLOUD:华为云
  • Azure:Azure
  • AWS:AWS
AWS
AkTypestring

AK 类型。取值:

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

AK 参数 Id。取值:

1.AkType 取值 primary:

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

2.AkType 取值 sub:

  • Tencent:子账号 AccessKeyId
  • HUAWEICLOUD:子账号 AccessKeyId
  • Azure:ClientId
  • AWS:子账号 AccessKeyId
45GLRV4SOT0YFB****
SecretKeystring

AK 参数 Secret。取值:

1.AkType 取值 primary:

  • Tencent:主账号 SecretAccessKey
  • HUAWEICLOUD:主账号 SecretAccessKey
  • Azure:ClientSecret
  • AWS:主账号 SecretAccessKey

2.AkType 取值 sub:

  • Tencent:子账号 SecretAccessKey
  • HUAWEICLOUD:子账号 SecretAccessKey
  • Azure:ClientSecret
  • AWS:子账号 SecretAccessKey
AE6SLd****
Regionsarray

AK 信息验证所使用的 Region 列表,仅对 Vendor 为 AWS 有效。

说明 调用 ListCloudVendorRegions 接口可以获取该参数。
regionsstring

AK 信息验证所使用的 Region。

ap-south-1
SubscriptionIdsarray

订阅 id 列表,仅对 Vendor 为 Azure 有效。

string

订阅 id。

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

租户 Id,仅对 Vendor 为 Azure 有效。

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

接入账号域,仅对 Vendor 为 Azure 有效。取值:

  • china:世纪互联
  • global:全球
global
AuthModulesarray

AK 关联模块列表。

string

AK 关联模块 Code。取值:

  • HOST:主机
  • CSPM:云产品配置检查
  • SIEM:CloudSiem
  • TRIAL:日志审计
HOST
Langstring

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

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

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

当前添加 AK 信息。

Statusinteger

AK 状态。取值:

  • 0:开启
  • 1:未开启
0
AuthIdlong

AK 唯一 ID。

2158
AkTypestring

AK 类型。取值:

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

AK 参数 Id。

AE6SLd****
ServiceStatusinteger

AK 使用状态。取值:

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

云资产厂商。取值:

  • Tencent:腾讯云
  • HUAWEICLOUD:华为云
  • Azure:Azure
  • AWS:AWS
Tencent
Messagestring

AK 异常信息。

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

AK 关联模块列表。

AuthModuleobject
ModuleDispstring

模块显示名称。

主机资产
ModuleStatementstring

模块关联权限说明。

云服务器或虚拟机读取权限
Modulestring

模块 Code。取值:

  • HOST:主机
  • CSPM:云产品配置检查
  • SIEM:CloudSiem
  • TRIAL:日志审计
HOST
ModuleAssetTypestring

模块关联云资产说明。

云服务器或虚拟机
ModuleServiceStatusinteger

模块状态。取值:

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

模块异常信息。

ak_domain_error

示例

正常返回示例

JSON格式

{
  "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": "主机资产",
        "ModuleStatement": "云服务器或虚拟机读取权限",
        "Module": "HOST",
        "ModuleAssetType": "云服务器或虚拟机\n",
        "ModuleServiceStatus": 0,
        "Message": "ak_domain_error"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-10-30OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-09-25OpenAPI 错误码发生变更查看变更详情