文档

ListGroups - 列表查询EIAM账户组信息

列表查询EIAM账户组列表信息。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumberlong

列表页码。

1
PageSizelong

列表大小。

20
GroupIdsarray

组 ID 列表。

string

组 ID。

group_d6sbsuumeta4h66ec3il7yxxxx
GroupNamestring

组名称,查询为精确匹配查询。

name_test
GroupNameStartsWithstring

组名称前缀,查询为左匹配查询。

name
GroupExternalIdstring

组外部 ID。

group_external_id

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

数据总条数目,为匹配到的总数量,单次返回最大数量以 pageSize 为准。

100
Groupsobject []

账户组列表对象。

GroupIdstring

组 ID。

group_d6sbsuumeta4h66ec3il7yxxxx
GroupNamestring

组名称。

group_name
Descriptionstring

组描述。

test group
GroupExternalIdstring

组外部标识,用于与外部系统关联,默认为账户组 ID。

group_d6sbsuumeta4h66ec3il7yxxxx
GroupSourceTypestring

组来源类型,目前只支持自建,取值可选范围:

  • build_in:自建。
build_in
GroupSourceIdstring

组来源 ID,若通过其他方式导入创建,此为外部来源 ID,默认为实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
CreateTimelong

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

1652085686179
UpdateTimelong

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

1652085686179
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Groups": [
    {
      "GroupId": "group_d6sbsuumeta4h66ec3il7yxxxx",
      "GroupName": "group_name",
      "Description": "test group",
      "GroupExternalId": "group_d6sbsuumeta4h66ec3il7yxxxx",
      "GroupSourceType": "build_in",
      "GroupSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CreateTime": 1652085686179,
      "UpdateTime": 1652085686179,
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈