ListUserGroupsForPrivateAccessPolicy - 批量查询内网访问策略的用户组

批量查询当前阿里云账号下内网访问策略的用户组。

调试

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

授权信息

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

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

请求参数

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

内网访问策略 ID 集合。最多可输入 100 个内网访问策略 ID。

string

内网访问策略 ID。取值来源:

pa-policy-1b0d0e8b4bcf****

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

58D6B23E-E5DA-5418-8F61-51A3B5A30049
Policesarray<object>

内网访问策略列表。

policyobject

内网访问策略。

PolicyIdstring

内网访问策略 ID。

pa-policy-1b0d0e8b4bcf****
UserGroupsarray<object>

内网访问策略的用户组集合。

userGroupobject

内网访问策略的用户组。

UserGroupIdstring

用户组 ID。

usergroup-6f1ef2fc56b6****
Namestring

用户组名称。

user_group_name
Descriptionstring

用户组描述。

这是一条被内网访问策略引用的用户组
Attributesarray<object>

用户组属性集合。

attributeobject

用户组属性。

UserGroupTypestring

用户组的类型。取值:

  • username:用户名。
  • department:部门。
  • email:邮箱。
  • telephone:手机。
department
Relationstring

用户组的关系。取值:

  • Equal:等于。
  • Unequal:不等于。
Equal
Valuestring

用户组属性的值。

  • 当用户组类型为 username 时,表示用户名的值。长度为 1~128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-)。
  • 当用户组类型为 department 时,表示部门的值。如:OU=部门 1,OU=SASE 钉钉。
  • 当用户组类型为 email 时,表示邮箱的值。如:username@example.com。
  • 当用户组类型为 telephone 时,表示手机的值。如:13900001234。
OU=部门1,OU=SASE钉钉
IdpIdinteger

用户组的身份源 ID。当自定义用户组类型为 department 时,存在该值。

12
CreateTimestring

用户组创建时间。

2022-09-27 18:10:25

示例

正常返回示例

JSON格式

{
  "RequestId": "58D6B23E-E5DA-5418-8F61-51A3B5A30049",
  "Polices": [
    {
      "PolicyId": "pa-policy-1b0d0e8b4bcf****",
      "UserGroups": [
        {
          "UserGroupId": "usergroup-6f1ef2fc56b6****",
          "Name": "user_group_name",
          "Description": "这是一条被内网访问策略引用的用户组",
          "Attributes": [
            {
              "UserGroupType": "department",
              "Relation": "Equal",
              "Value": "OU=部门1,OU=SASE钉钉",
              "IdpId": 12
            }
          ],
          "CreateTime": "2022-09-27 18:10:25\n"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-12API 内部配置变更,不影响调用查看变更详情