- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Examples
- Try it!
globalOperations.list all of the ordered rules present in a single specified policy.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/securityPolicies/{resourceId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
resourceId |
Name of the security policy to get. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "rules": [ { "description": string, "priority": integer, "match": { "expr": { "expression": string, "title": string, "description": string, "location": string }, "versionedExpr": enum, "config": { "srcIpRanges": [ string ] } }, "action": string, "preview": boolean, "kind": string } ], "fingerprint": string, "selfLink": string, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
description |
An optional description of this resource. Provide this property when you create the resource. |
rules[] |
A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. |
rules[].description |
An optional description of this resource. Provide this property when you create the resource. |
rules[].priority |
An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. |
rules[].match |
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. |
rules[].match.expr |
User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. |
rules[].match.expr.expression |
Textual representation of an expression in Common Expression Language syntax. |
rules[].match.expr.title |
Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
rules[].match.expr.description |
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
rules[].match.expr.location |
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
rules[].match.versionedExpr |
Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config. |
rules[].match.config |
The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified. |
rules[].match.config.srcIpRanges[] |
CIDR IP address range. Maximum number of src_ip_ranges allowed is 10. |
rules[].action |
The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny( |
rules[].preview |
If set to true, the specified action is not enforced. |
rules[].kind |
[Output only] Type of the resource. Always |
fingerprint |
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error To see the latest fingerprint, make A base64-encoded string. |
selfLink |
[Output Only] Server-defined URL for the resource. |
kind |
[Output only] Type of the resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.securityPolicies.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.