ListPolicesForPrivateAccessTag-阿里云帮助中心

Batch query policies for private network access tags in your Alibaba Cloud account.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

csas:ListPolicesForPrivateAccessTag

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TagIds	array	Yes	A collection of private network access tag IDs. Enter a maximum of 100 private network access tag IDs.
	string	No	The private network access tag ID. Obtain this value from: ListPrivateAccessTags: Batch query private network access tags. CreatePrivateAccessTag: Create private network access tags.	tag-b927baf3e592****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of this request.	4D169859-A4F2-5EC8-853B-8447787C0D8A
Tags	array<object>	List of private network access tags.
	array<object>	Private network access tag.
TagId	string	Private network access tag ID.	tag-b927baf3e592****
Polices	array<object>	Collection of private network access policies.
	array<object>	Private network access policy.
PolicyId	string	Private network access policy ID.	pa-policy-867ef4007c8a****
Name	string	Private network access policy name.	private_access_policy_name
Description	string	Description of the private network access policy.	这是一条内网访问策略
PolicyAction	string	The action that the private access policy performs. Valid values: Block: Blocks access. Allow: Allows access. Valid values: Block : Blocks access. Allow : Allows access.	Allow
Priority	integer	The private network access policy priority. The number 1 indicates the highest priority.	1
Status	string	The status of the private network access policy. Values: Enabled: Enabled. Disabled: Disabled. Valid values: Enabled : Enabled Disabled : Disabled	Enabled
ApplicationType	string	The application type of the private network access policy. Values: Application: Application. Tag: Tag. Valid values: Tag : Tag Application : Application	Application
UserGroupType	string	The user group type of the private network access policy. Values: Normal: Normal user group. Custom: Custom user group. Valid values: Custom : Custom Normal : Normal	Normal
CustomUserAttributes	array<object>	A collection of custom user group attributes. Multiple custom user group attributes have an OR relationship and take effect as a union.
	object	Custom user group attribute.
UserGroupType	string	The type of user group. Values: username: Username. department: Department. email: Mailbox. telephone: Mobile phone. Valid values: telephone : Mobile phone department : Department email : Mailbox username : Username	department
Relation	string	The relationship of the user group. Values: Equal: Equal. Unequal: Unequal. Valid values: Unequal : Unequal Equal : Equal	Equal
Value	string	The value of the user group attribute. If the user group type is username, this indicates the username's value. The length is 1 to 128 characters. It supports Chinese characters, uppercase and lowercase English letters, and can include numbers, periods (.), underscores (_), and hyphens (-). If the user group type is department, this indicates the department's value. For example: OU=Department 1,OU=SASE DingTalk. If the user group type is email, this indicates the mailbox's value. For example: username@example.com. If the user group type is telephone, this indicates the mobile phone's value. For example: 13900001234.	OU=部门1,OU=SASE钉钉
IdpId	integer	The identity provider ID of the user group. This value exists if the custom user group type is department.	12
CreateTime	string	Creation time of the private network access policy.	2023-02-21 14:10:16

Examples

Success response

JSON format

{
  "RequestId": "4D169859-A4F2-5EC8-853B-8447787C0D8A",
  "Tags": [
    {
      "TagId": "tag-b927baf3e592****\n",
      "Polices": [
        {
          "PolicyId": "pa-policy-867ef4007c8a****",
          "Name": "private_access_policy_name\n",
          "Description": "这是一条内网访问策略",
          "PolicyAction": "Allow",
          "Priority": 1,
          "Status": "Enabled",
          "ApplicationType": "Application",
          "UserGroupType": "Normal",
          "CustomUserAttributes": [
            {
              "UserGroupType": "department\n",
              "Relation": "Equal",
              "Value": "OU=部门1,OU=SASE钉钉",
              "IdpId": 12
            }
          ],
          "CreateTime": "2023-02-21 14:10:16"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.