全部产品
Search
文档中心

运维安全中心(堡垒机):GetPolicyUserScope - 获取指定控制策略生效用户范围

更新时间:Oct 25, 2024

获取指定控制策略生效用户范围。

调试

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

授权信息

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

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

请求参数

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

指定要查询的控制策略所在堡垒机的实例 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastion-xxxx-xx
RegionIdstring

指定要查询的控制策略所在堡垒机的区域 ID。

说明 区域 ID 和区域名称的对应关系,请参见地域和可用区
cn-hangzhou
PolicyIdstring

指定要查询的控制策略 ID。

说明 您可以调用 ListPolicies 接口获取该参数。
1

返回参数

名称类型描述示例值
object
RequestIdstring

阿里云为该请求生成的唯一标识符。

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
UserScopeobject

控制策略生效的用户范围。

ScopeTypestring

控制策略生效的用户范围。

说明
  • 返回 All 时表示策略针对所有用户生效。
  • 返回空值表示策略对指定用户生效,具体生效范围为 UserGroupIds 和 UserIds 的返回值。
  • All
    UserGroupIdsarray

    控制策略生效的用户组范围。

    itemstring

    用户组 ID。

    ["1", "2", "3"]
    UserIdsarray

    控制策略生效的用户范围。

    itemstring

    用户 ID。

    ["1", "2", "3"]

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
      "UserScope": {
        "ScopeType": "All",
        "UserGroupIds": [
          "[\"1\", \"2\", \"3\"]"
        ],
        "UserIds": [
          "[\"1\", \"2\", \"3\"]"
        ]
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParameterThe argument is invalid.参数错误
    500InternalErrorAn unknown error occurred.未知错误

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