调用GetPrivateAccessPolicy查询内网访问策略详情_办公安全平台(SASE)-阿里云帮助中心

获取当前阿里云账号下指定内网访问策略的详情信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
csas:GetPrivateAccessPolicy	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
PolicyId	string	是	内网访问策略 ID。取值来源： ListPrivateAccessPolices ：批量查询内网访问策略。 CreatePrivateAccessPolicy ：创建内网访问策略。	pa-policy-63b2f1844b86****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	7E9D7ACD-53D5-56EF-A913-79D148D06299
Policy	object	内网访问策略。
PolicyId	string	内网访问策略 ID。	pa-policy-63b2f1844b86****
Name	string	内网访问策略名称。	private_access_policy_name
Description	string	内网访问策略描述。	这是一条内网访问策略
PolicyAction	string	内网访问策略动作。取值： Block：阻断。 Allow：允许。	Allow
Priority	integer	内网访问策略优先级。数字 1 表示优先级最高。	1
Status	string	内网访问策略状态。取值： Enabled：开启。 Disabled：关闭。	Enabled
CreateTime	string	内网访问策略创建时间。	2021-07-29 11:26:02
UserGroupMode	string	内网访问策略的用户组类型。取值： Normal：普通用户组。 Custom：自定义用户组。	Normal
UserGroupIds	array	内网访问策略，用户组 ID 集合。当用户组类型为 Normal 时，该字段有值。
userGroupId	string	内网访问策略，用户组类型为 Normal 的用户组 ID。	usergroup-6f1ef2fc56b6****
CustomUserAttributes	array<object>	自定义用户组属性集合。多个自定义用户组属性之间是或的关系，按照合集生效。
customUserAttribute	object	自定义用户组属性。
UserGroupType	string	自定义用户组的类型。取值： username：用户名。 department：部门。 email：邮箱。 telephone：手机。	department
Relation	string	自定义用户组的关系。取值： Equal：等于。 Unequal：不等于。	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：标签。	Application
ApplicationIds	array	内网访问策略的应用 ID 集合。当应用类型为 Application 时，该字段有值。
applicationId	string	内网访问策略的应用 ID。	pa-application-e12860ef6c48****
TagIds	array	内网访问策略的标签 ID 集合。当应用类型为 Tag 时，该字段有值。
tagId	string	内网访问策略的标签 ID。	tag-d3f64e8bdd4a****
DeviceAttributeId	string	安全基线策略的 ID。	dag-d3f64e8bdd4a****

示例

正常返回示例

JSON格式

{
  "RequestId": "7E9D7ACD-53D5-56EF-A913-79D148D06299",
  "Policy": {
    "PolicyId": "pa-policy-63b2f1844b86****",
    "Name": "private_access_policy_name",
    "Description": "这是一条内网访问策略",
    "PolicyAction": "Allow",
    "Priority": 1,
    "Status": "Enabled",
    "CreateTime": "2021-07-29 11:26:02",
    "UserGroupMode": "Normal",
    "UserGroupIds": [
      "usergroup-6f1ef2fc56b6****"
    ],
    "CustomUserAttributes": [
      {
        "UserGroupType": "department",
        "Relation": "Equal",
        "Value": "OU=部门1,OU=SASE钉钉",
        "IdpId": 12
      }
    ],
    "ApplicationType": "Application",
    "ApplicationIds": [
      "pa-application-e12860ef6c48****\n"
    ],
    "TagIds": [
      "tag-d3f64e8bdd4a****\n"
    ],
    "DeviceAttributeId": "dag-d3f64e8bdd4a****",
    "DeviceAttributeAction": ""
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-06-18	OpenAPI 返回结构发生变更	查看变更详情
2024-01-25	OpenAPI 返回结构发生变更	查看变更详情