AI 助理
文档备案控制台
官方文档
首页

ListPrivateAccessPolices - 批量查询内网访问策略

更新时间：
复制 MD 格式
产品详情
我的收藏

获取当前阿里云账号下所有内网访问策略的信息。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

csas:ListPrivateAccessPolices

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
CurrentPage

integer

是

分页查询时显示的当前页的页码。取值：1~10000。

1
PageSize

integer

是

分页查询时设置的每页数量。取值：1~1000。

10
Name

string

否

内网访问策略名称。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。

private_access_policy_name
Status

string

否

内网访问策略状态。取值：

  • Enabled：开启。

  • Disabled：关闭。

枚举值：

  • Enabled :

    开启

  • Disabled :

    关闭

Enabled
PolicyAction

string

否

内网访问策略动作。取值：

  • Block：阻断。

  • Allow：允许。

枚举值：

  • Block :

    阻断

  • Allow :

    允许

Allow
PolicyIds

array

否

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

string

否

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

pa-policy-63b2f1844b86****
UserGroupId

string

否

用户组 ID。取值来源：

usergroup-6f1ef2fc56b6****
ApplicationId

string

否

内网访问应用 ID。无法和内网访问标签 ID 同时过滤。取值来源：

pa-application-e12860ef6c48****
TagId

string

否

内网访问标签 ID。无法和应用 ID 同时过滤。取值来源：

tag-c0cb77857a99****
ApplicationName

string

否

内网访问应用名称。

办公
TagName

string

否

标签名称。

云产品

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次请求的 ID。

748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D
TotalNum

integer

内网访问策略的总数。

1
Polices

array<object>

内网访问策略列表。

array<object>

内网访问策略。

PolicyId

string

内网访问策略 ID。

pa-policy-63b2f1844b86****
Name

string

内网访问策略名称。

private_access_policy_name
Description

string

内网访问策略描述。

这是一条内网访问策略
PolicyAction

string

内网访问策略动作。取值：

  • Block：阻断。

  • Allow：允许。

枚举值：

  • Block :

    阻断

  • Allow :

    允许

Allow
Priority

integer

内网访问策略优先级。数字 1 表示优先级最高。

1
Status

string

内网访问策略状态。取值：

  • Enabled：开启。

  • Disabled：关闭。

枚举值：

  • Enabled :

    开启

  • Disabled :

    关闭

Enabled
CreateTime

string

内网访问策略创建时间。

2022-07-10 15:50:23
UserGroupMode

string

内网访问策略的用户组类型。取值：

  • Normal：普通用户组。

  • Custom：自定义用户组。

枚举值：

  • Custom :

    自定义用户组

  • Normal :

    普通用户组

Normal
UserGroupIds

array

内网访问策略，用户组 ID 集合。当用户组类型为 Normal 时，该字段有值。

string

内网访问策略，用户组类型为 Normal 的用户组 ID。

usergroup-6f1ef2fc56b6****
CustomUserAttributes

array<object>

自定义用户组属性集合。多个自定义用户组属性之间是或的关系，按照合集生效。

object

自定义用户组属性。

UserGroupType

string

用户组的类型。取值：

  • username：用户名。

  • department：部门。

  • email：邮箱。

  • telephone：手机。

枚举值：

  • telephone :

    手机

  • department :

    部门

  • email :

    邮箱

  • username :

    用户名

department
Relation

string

用户组的关系。取值：

  • Equal：等于。

  • Unequal：不等于。

枚举值：

  • Unequal :

    不等于

  • Equal :

    等于

Equal
Value

string

用户组属性的值。

  • 当用户组类型为 username 时，表示用户名的值。长度为 1~128 个字符，支持中文和大小写英文字母，可包含数字、半角句号（.）、下划线（_）和短划线（-）。

  • 当用户组类型为 department 时，表示部门的值。如：OU=部门 1,OU=SASE 钉钉。

  • 当用户组类型为 email 时，表示邮箱的值。如：username@example.com。

  • 当用户组类型为 telephone 时，表示手机的值。如：13900001234。

OU=部门1,OU=SASE钉钉
IdpId

integer

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

12
ApplicationType

string

内网访问策略的应用类型。取值：

  • Application：应用。

  • Tag：标签。

枚举值：

  • Tag :

    标签

  • Application :

    应用

Application
ApplicationIds

array

内网访问策略的应用 ID 集合。当应用类型为 Application 时，该字段有值。

string

内网访问策略的应用 ID。

pa-application-e12860ef6c48****
TagIds

array

内网访问策略的标签 ID 集合。当应用类型为 Tag 时，该字段有值。

string

内网访问策略的标签 ID。

tag-d3f64e8bdd4a****
DeviceAttributeId

string

安全基线策略的 ID。

dag-d3f64e8bdd4a****
DeviceAttributeAction

string

不满足安全基线的执行策略。取值：

  • Block：拦截。

  • Observe：观察。

枚举值：

  • Observe :

    Observe

  • Block :

    Block

Block
TriggerTemplateId

string

触发模板 ID

dag-d3f64e8bdd4a****
TrustedProcessStatus

string

可信进程开关状态。取值：

  • Enabled：开启。

  • Disabled：关闭。

Enabled
TrustedProcessGroupIds

array

可信进程组 ID 列表。

string

可信进程组 ID。

pg-xxxxxxx
TrustedSoftwareIds

array

可信软件 ID 列表。

string

可信软件 ID。

swb-xxxxxxxx
ValidFrom

integer

零信任策略的生效起始时间，为秒级时间戳。

0
ValidUntil

integer

零信任策略的生效截止时间，为秒级时间戳。

1764727544
ValidTimeStatus

string

生效时间开关状态。取值：

  • Enabled：开启。

  • Disabled：关闭。

Enabled

示例

正常返回示例

JSON格式

{
  "RequestId": "748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D",
  "TotalNum": 1,
  "Polices": [
    {
      "PolicyId": "pa-policy-63b2f1844b86****",
      "Name": "private_access_policy_name",
      "Description": "这是一条内网访问策略",
      "PolicyAction": "Allow",
      "Priority": 1,
      "Status": "Enabled",
      "CreateTime": "2022-07-10 15:50:23",
      "UserGroupMode": "Normal",
      "UserGroupIds": [
        "usergroup-6f1ef2fc56b6****"
      ],
      "CustomUserAttributes": [
        {
          "UserGroupType": "department",
          "Relation": "Equal",
          "Value": "OU=部门1,OU=SASE钉钉",
          "IdpId": 12
        }
      ],
      "ApplicationType": "Application",
      "ApplicationIds": [
        "pa-application-e12860ef6c48****"
      ],
      "TagIds": [
        "tag-d3f64e8bdd4a****"
      ],
      "DeviceAttributeId": "dag-d3f64e8bdd4a****",
      "DeviceAttributeAction": "Block",
      "TriggerTemplateId": "dag-d3f64e8bdd4a****",
      "TrustedProcessStatus": "Enabled",
      "TrustedProcessGroupIds": [
        "pg-xxxxxxx"
      ],
      "TrustedSoftwareIds": [
        "swb-xxxxxxxx"
      ],
      "ValidFrom": 0,
      "ValidUntil": 1764727544,
      "ValidTimeStatus": "Enabled"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：内网访问策略下一篇：ListUserGroupsForPrivateAccessPolicy - 批量查询内网访问策略的用户组