ListCloudAccounts - 列表查询云账号

更新时间:
复制 MD 格式

分页查询一个或者多个云账号信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eiam:ListCloudAccounts

list

*CloudAccount

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

NextToken

string

用于标识下一个分页的起始位置的 Token。

  • 当不传时,默认从第一页开始查询。

NTxxxxxexample

MaxResults

integer

分页的最大记录数。

  • 当不传递时默认为 20。

  • 限制最大值不超过 100。

20

Filter

array<object>

过滤条件。

object

过滤条件。

Name

string

过滤字段名称。取值可选范围:

  • CloudAccountId:云账号 ID。

  • CloudAccountExternalId:云账号外部唯一标识。

  • CloudAccountVendorType:云账号类型。

枚举值:

  • CloudAccountVendorType :

    CloudAccountVendorType

  • CloudAccountExternalId :

    CloudAccountExternalId

  • CloudAccountId :

    CloudAccountId

CloudAccountId

Value

array

过滤字段取值列表。

string

过滤字段取值。

ca_01kmegjc11qa1txxxxx

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

TotalCount

integer

列表总条数目。

100

NextToken

string

本次调用返回的查询凭证(Token)值。

NTxxxexample

MaxResults

integer

分页查询时每页行数。

20

CloudAccounts

array<object>

云账号列表。

array<object>

云账号详情。

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CloudAccountId

string

云账号 ID。

ca_01kmegjc11qa1txxxxx

CloudAccountName

string

云账号名称。

cloud_accout_xxxx

CloudAccountVendorType

string

云账号类型。取值可选范围:

  • alibaba_cloud:阿里云

alibaba_cloud

CloudAccountExternalId

string

云账号外部唯一标识。

1234567

CloudAccountProviderName

string

身份提供商名称。

idaas-eiam-oidc-provider

CloudAccountHealth

string

云账号健康状态。取值可选范围:

  • healthy:健康。

  • unhealthy:不健康。

  • unknown:未知。

枚举值:

  • healthy :

    healthy

  • unhealthy :

    unhealthy

  • unknown :

    unknown

healthy

Description

string

云账号描述。

cloud_accout_description

CreateTime

integer

创建时间,Unix 时间戳格式,单位为毫秒。

1649830225000

UpdateTime

integer

最近更新时间,Unix 时间戳格式,单位为毫秒。

1649830227000

CloudAccountHealthCheckResult

object

云账号健康状态检查结果。

LastCheckTime

integer

最后一次检测时间,Unix 时间戳格式,单位为毫秒。

1649830226000

Result

string

云账号健康检查结果。取值可选范围:

  • success:成功。

  • failed:失败。

枚举值:

  • success :

    success

  • failed :

    failed

success

ErrorReason

object

错误原因。当健康检查状态为 unhealthy 时,该字段会返回值。

ErrorCode

string

错误码。

AuthenticationFail.NoPermission

ErrorMessage

string

错误描述。

There is no permission.

CloudAccountSite

string

云账号站点

PrivilegeHostingState

string

特权托管状态,即是否有特权能力

PrivilegeStatus

string

特权的开关状态,即特权能力是否可用

PrivilegeApplicationIds

array

关联的特权应用 ID 列表

string

PrivilegeHostingError

object

特权托管或移除失败原因

ErrorCode

string

失败错误码

ErrorMessage

string

失败信息

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "MaxResults": 20,
  "CloudAccounts": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CloudAccountId": "ca_01kmegjc11qa1txxxxx",
      "CloudAccountName": "cloud_accout_xxxx",
      "CloudAccountVendorType": "alibaba_cloud",
      "CloudAccountExternalId": "1234567",
      "CloudAccountProviderName": "idaas-eiam-oidc-provider",
      "CloudAccountHealth": "healthy",
      "Description": "cloud_accout_description",
      "CreateTime": 1649830225000,
      "UpdateTime": 1649830227000,
      "CloudAccountHealthCheckResult": {
        "LastCheckTime": 1649830226000,
        "Result": "success",
        "ErrorReason": {
          "ErrorCode": "AuthenticationFail.NoPermission",
          "ErrorMessage": "There is no permission."
        }
      },
      "CloudAccountSite": "",
      "PrivilegeHostingState": "",
      "PrivilegeStatus": "",
      "PrivilegeApplicationIds": [
        ""
      ],
      "PrivilegeHostingError": {
        "ErrorCode": "",
        "ErrorMessage": ""
      }
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情