ListCloudAccountRoles - 列表查询云角色

更新时间:
复制为 MD 格式

分页查询一个或者多个云角色信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

CloudAccountId

string

云账号 ID。

ca_01kmegjc11qa1txxxxx

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

NextToken

string

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

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

NTxxxxxexample

MaxResults

integer

分页的最大记录数。

  • 当不传递时默认为 20。

  • 限制最大值不超过 100。

20

Filter

array<object>

过滤条件。

object

过滤条件。

Name

string

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

  • CloudAccountRoleId:云角色 ID。

  • CloudAccountRoleName:云角色名称。

  • CloudAccountRoleExternalId:云角色业务标识。

  • CloudAccountRoleUsageType:云角色使用类型。

枚举值:

  • CloudAccountRoleId :

    CloudAccountRoleId

  • CloudAccountRoleName :

    CloudAccountRoleName

  • CloudAccountRoleUsageType :

    CloudAccountRoleUsageType

  • CloudAccountRoleExternalId :

    CloudAccountRoleExternalId

CloudAccountRoleId

Value

array

过滤字段取值列表。

string

过滤字段取值。

carole_01kmek49aqxxxx

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

TotalCount

integer

列表总条数目。

100

NextToken

string

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

NTxxxexample

MaxResults

integer

分页查询时每页行数。

20

CloudAccountRoles

array<object>

云角色列表。

array<object>

云角色详情。

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CloudAccountId

string

云账号 ID。

ca_01kmegjc11qa1txxxxx

CloudAccountRoleId

string

云角色 ID。

carole_01kmek49aqxxxx

CloudAccountRoleType

string

云角色类型。具体形式取决于云账号类型。当前支持的取值包括:

  • role:适用于阿里云账号。

枚举值:

  • role :

    role

role

CloudAccountRoleUsageType

string

云角色使用类型。取值可选范围:

  • system:系统。

  • user:用户。

枚举值:

  • system :

    system

  • user :

    user

system

CloudAccountRoleName

string

云角色名称。

role-test

CloudAccountRoleExternalId

string

云角色标识。

acs:ram::xxx:role/role-test

CloudAccountRoleHealth

string

云角色健康状态。取值可选范围:

  • healthy:健康。

  • unhealthy:不健康。

  • unknown:未知。

枚举值:

  • healthy :

    healthy

  • unhealthy :

    unhealthy

  • unknown :

    unknown

healthy

Status

string

云角色状态。取值可选范围:

  • enabled:启用。

  • disable:禁用。

枚举值:

  • disabled :

    disabled

  • enabled :

    enabled

enabled

Description

string

云角色描述。

cloud_account_role_description

CreateTime

integer

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

1719320115000

UpdateTime

integer

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

1719320117000

CloudAccountRoleHealthCheckResult

object

云角色健康状态检查结果。

Result

string

云角色健康检查结果。取值可选范围:

  • success:成功。

  • failed:失败。

枚举值:

  • success :

    success

  • failed :

    failed

success

LastCheckTime

integer

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

1649830226000

ErrorReason

object

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

ErrorCode

string

错误码。

AuthenticationFail.NoPermission

ErrorMessage

string

错误描述。

There is no permission.

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "MaxResults": 20,
  "CloudAccountRoles": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CloudAccountId": "ca_01kmegjc11qa1txxxxx",
      "CloudAccountRoleId": "carole_01kmek49aqxxxx",
      "CloudAccountRoleType": "role",
      "CloudAccountRoleUsageType": "system",
      "CloudAccountRoleName": "role-test",
      "CloudAccountRoleExternalId": "acs:ram::xxx:role/role-test",
      "CloudAccountRoleHealth": "healthy",
      "Status": "enabled",
      "Description": "cloud_account_role_description",
      "CreateTime": 1719320115000,
      "UpdateTime": 1719320117000,
      "CloudAccountRoleHealthCheckResult": {
        "Result": "success",
        "LastCheckTime": 1649830226000,
        "ErrorReason": {
          "ErrorCode": "AuthenticationFail.NoPermission",
          "ErrorMessage": "There is no permission."
        }
      }
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情