Method: batchGetAssetsHistory

Batch gets the update history of assets that overlap a time window. For RESOURCE content, this API outputs history with asset in both non-delete or deleted status. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

HTTP request

GET https://cloudasset.googleapis.com/v1/{parent=*/*}:batchGetAssetsHistory

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").

Authorization requires one or more of the following Google IAM permissions on the specified resource parent:

  • cloudasset.assets.exportResource
  • cloudasset.assets.exportIamPolicy

Query parameters

Parameters
assetNames

string

A list of the full names of the assets. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Resource Names and Resource name Format for more info.

The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request.

contentType

enum (ContentType)

Required. The content type.

readTimeWindow

object (TimeWindow)

Optional. The time window for the asset history. Both startTime and endTime are optional and if set, it must be after 2018-10-02 UTC. If endTime is not set, it is default to current timestamp. If startTime is not set, the snapshot of the assets at endTime will be returned. The returned results contain all temporal assets whose time window overlap with readTimeWindow.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Batch get assets history response.

JSON representation
{
  "assets": [
    {
      object (TemporalAsset)
    }
  ]
}
Fields
assets[]

object (TemporalAsset)

A list of assets with valid time windows.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

TimeWindow

A time window of (startTime, endTime].

JSON representation
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

instances.start time of the time window (exclusive).

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

End time of the time window (inclusive). Current timestamp if not specified.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

TemporalAsset

Temporal asset. In addition to the asset, the temporal asset includes the status of the asset and valid from and to time of it.

JSON representation
{
  "window": {
    object (TimeWindow)
  },
  "deleted": boolean,
  "asset": {
    object (Asset)
  }
}
Fields
window

object (TimeWindow)

The time window when the asset data and state was observed.

deleted

boolean

If the asset is deleted or not.

asset

object (Asset)

Asset.

Asset

Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets.

JSON representation
{
  "name": string,
  "assetType": string,
  "resource": {
    object (Resource)
  },
  "iamPolicy": {
    object (Policy)
  },
  "orgPolicy": [
    {
      object (Policy)
    }
  ],
  "ancestors": [
    string
  ],

  // Union field access_context_policy can be only one of the following:
  "accessPolicy": {
    object (AccessPolicy)
  },
  "accessLevel": {
    object (AccessLevel)
  },
  "servicePerimeter": {
    object (ServicePerimeter)
  }
  // End of list of possible types for union field access_context_policy.
}
Fields
name

string

The full name of the asset. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Resource Names for more information.

assetType

string

type of the asset. Example: "compute.googleapis.com/Disk".

resource

object (Resource)

Representation of the resource.

iamPolicy

object (Policy)

Representation of the actual Cloud IAM policy set on a cloud resource. For each resource, there must be at most one Cloud IAM policy set on it.

orgPolicy[]

object (Policy)

Representation of the Cloud Organization Policy set on an asset. For each asset, there could be multiple Organization policies with different constraints.

ancestors[]

string

Asset's ancestry path in Cloud Resource Manager (CRM) hierarchy, represented as a list of relative resource names. Ancestry path starts with the closest CRM ancestor and ends at root. If the asset is a CRM project/folder/organization, this starts from the asset itself.

Example: ["projects/123456789", "folders/5432", "organizations/1234"]

Union field access_context_policy. Representation of the Cloud Organization access policy. access_context_policy can be only one of the following:
accessPolicy

object (AccessPolicy)

accessLevel

object (AccessLevel)

servicePerimeter

object (ServicePerimeter)

Resource

Representation of a cloud resource.

JSON representation
{
  "version": string,
  "discoveryDocumentUri": string,
  "discoveryName": string,
  "resourceUrl": string,
  "parent": string,
  "data": {
    object
  }
}
Fields
version

string

The API version. Example: "v1".

discoveryDocumentUri

string

The URL of the discovery document containing the resource's JSON schema. For example: "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest". It will be left unspecified for resources without a discovery-based API, such as Cloud Bigtable.

discoveryName

string

The JSON schema name listed in the discovery document. Example: "Project". It will be left unspecified for resources (such as Cloud Bigtable) without a discovery-based API.

resourceUrl

string

The REST URL for accessing the resource. An HTTP GET operation using this URL returns the resource itself. Example: https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123. It will be left unspecified for resources without a REST API.

parent

string

The full name of the immediate parent of this resource. See Resource Names for more information.

For GCP assets, it is the parent resource defined in the Cloud IAM policy hierarchy. For example: "//cloudresourcemanager.googleapis.com/projects/my_project_123".

For third-party assets, it is up to the users to define.

data

object (Struct format)

The content of the resource, in which some sensitive fields are scrubbed away and may not be present.

Policy

Defines a Cloud Organization Policy which is used to specify Constraints for configurations of Cloud Platform resources.

JSON representation
{
  "version": number,
  "constraint": string,
  "etag": string,
  "updateTime": string,

  // Union field policy_type can be only one of the following:
  "listPolicy": {
    object (ListPolicy)
  },
  "booleanPolicy": {
    object (BooleanPolicy)
  },
  "restoreDefault": {
    object (RestoreDefault)
  }
  // End of list of possible types for union field policy_type.
}
Fields
version

number

Version of the Policy. Default version is 0;

constraint

string

The name of the Constraint the Policy is configuring, for example, constraints/serviceuser.services.

Immutable after creation.

etag

string (bytes format)

An opaque tag indicating the current version of the Policy, used for concurrency control.

When the Policy is returned from either a globalAddresses.getIamPolicy or a ListOrgPolicy request, this etag indicates the version of the current Policy to use when executing a read-modify-write loop.

When the Policy is returned from a GetEffectivePolicy request, the etag will be unset.

When the Policy is used in a SetOrgPolicy method, use the etag value that was returned from a GetOrgPolicy request as part of a read-modify-write loop for concurrency control. Not setting the etagin a SetOrgPolicy request will result in an unconditional write of the Policy.

A base64-encoded string.

updateTime

string (Timestamp format)

The time stamp the Policy was previously updated. This is set by the server, not specified by the caller, and represents the last time a call to SetOrgPolicy was made for that Policy. Any value set by the client will be ignored.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Union field policy_type. The field to populate is based on the constraint_type value in the Constraint. list_constraint => list_policy boolean_constraint => boolean_policy

A restore_default message may be used with any Constraint type.

Providing a *_policy that is incompatible with the constraint_type will result in an invalid_argument error.

Attempting to set a Policy with a policy_type not set will result in an invalid_argument error. policy_type can be only one of the following:

listPolicy

object (ListPolicy)

globalOperations.list of values either allowed or disallowed.

booleanPolicy

object (BooleanPolicy)

For boolean Constraints, whether to enforce the Constraint or not.

restoreDefault

object (RestoreDefault)

Restores the default behavior of the constraint; independent of Constraint type.

ListPolicy

Used in policy_type to specify how listPolicy behaves at this resource.

ListPolicy can define specific values and subtrees of Cloud Resource Manager resource hierarchy (Organizations, Folders, Projects) that are allowed or denied by setting the allowedValues and deniedValues fields. This is achieved by using the under: and optional is: prefixes. The under: prefix is used to denote resource subtree values. The is: prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - "projects/", e.g. "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", e.g. "organizations/1234" The supportsUnder field of the associated Constraint defines whether ancestry prefixes can be used. You can set allowedValues and deniedValues in the same Policy if allValues is ALL_VALUES_UNSPECIFIED. ALLOW or DENY are used to allow or deny all values. If allValues is set to either ALLOW or DENY, allowedValues and deniedValues must be unset.

JSON representation
{
  "allowedValues": [
    string
  ],
  "deniedValues": [
    string
  ],
  "allValues": enum (AllValues),
  "suggestedValue": string,
  "inheritFromParent": boolean
}
Fields
allowedValues[]

string

globalOperations.list of values allowed at this resource. Can only be set if allValues is set to ALL_VALUES_UNSPECIFIED.

deniedValues[]

string

globalOperations.list of values denied at this resource. Can only be set if allValues is set to ALL_VALUES_UNSPECIFIED.

allValues

enum (AllValues)

The policy allValues state.

suggestedValue

string

Optional. The Google Cloud Console will try to default to a configuration that matches the value specified in this Policy. If suggestedValue is not set, it will inherit the value specified higher in the hierarchy, unless inheritFromParent is false.

inheritFromParent

boolean

Determines the inheritance behavior for this Policy.

By default, a ListPolicy set at a resource supercedes any Policy set anywhere up the resource hierarchy. However, if inheritFromParent is set to true, then the values from the effective Policy of the parent resource are inherited, meaning the values set in this Policy are added to the values inherited up the hierarchy.

Setting Policy hierarchies that inherit both allowed values and denied values isn't recommended in most circumstances to keep the configuration simple and understandable. However, it is possible to set a Policy with allowedValues set that inherits a Policy with deniedValues set. In this case, the values that are allowed must be in allowedValues and not present in deniedValues.

For example, suppose you have a Constraint constraints/serviceuser.services, which has a constraint_type of listConstraint, and with constraintDefault set to ALLOW. Suppose that at the Organization level, a Policy is applied that restricts the allowed API activations to {E1, E2}. Then, if a Policy is applied to a project below the Organization that has inheritFromParent set to false and field allValues set to DENY, then an attempt to activate any API will be denied.

The following examples demonstrate different possible layerings for projects/bar parented by organizations/foo:

Example 1 (no inherited values): organizations/foo has a Policy with values: {allowedValues: "E1" allowedValues:"E2"} projects/bar has inheritFromParent false and values: {allowedValues: "E3" allowedValues: "E4"} The accepted values at organizations/foo are E1, E2. The accepted values at projects/bar are E3, and E4.

Example 2 (inherited values): organizations/foo has a Policy with values: {allowedValues: "E1" allowedValues:"E2"} projects/bar has a Policy with values: {value: "E3" value: "E4" inheritFromParent: true} The accepted values at organizations/foo are E1, E2. The accepted values at projects/bar are E1, E2, E3, and E4.

Example 3 (inheriting both allowed and denied values): organizations/foo has a Policy with values: {allowedValues: "E1" allowedValues: "E2"} projects/bar has a Policy with: {deniedValues: "E1"} The accepted values at organizations/foo are E1, E2. The value accepted at projects/bar is E2.

Example 4 (RestoreDefault): organizations/foo has a Policy with values: {allowedValues: "E1" allowedValues:"E2"} projects/bar has a Policy with values: {RestoreDefault: {}} The accepted values at organizations/foo are E1, E2. The accepted values at projects/bar are either all or none depending on the value of constraintDefault (if ALLOW, all; if DENY, none).

Example 5 (no policy inherits parent policy): organizations/foo has no Policy set. projects/bar has no Policy set. The accepted values at both levels are either all or none depending on the value of constraintDefault (if ALLOW, all; if DENY, none).

Example 6 (ListConstraint allowing all): organizations/foo has a Policy with values: {allowedValues: "E1" allowedValues: "E2"} projects/bar has a Policy with: {all: ALLOW} The accepted values at organizations/foo are E1, E2. Any value is accepted atprojects/bar`.

Example 7 (ListConstraint allowing none): organizations/foo has a Policy with values: {allowedValues: "E1" allowedValues: "E2"} projects/bar has a Policy with: {all: DENY} The accepted values at organizations/foo are E1, E2. No value is accepted atprojects/bar`.

Example 10 (allowed and denied subtrees of Resource Manager hierarchy): Given the following resource hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, organizations/foo has a Policy with values: {allowedValues: "under:organizations/O1"} projects/bar has a Policy with: {allowedValues: "under:projects/P3"} {deniedValues: "under:folders/F2"} The accepted values at organizations/foo are organizations/O1, folders/F1, folders/F2, projects/P1, projects/P2, projects/P3. The accepted values at projects/bar are organizations/O1, folders/F1, projects/P1.

AllValues

This enum can be used to set Policies that apply to all possible configuration values rather than specific values in allowedValues or deniedValues.

Settting this to ALLOW will mean this Policy allows all values. Similarly, setting it to DENY will mean no values are allowed. If set to either ALLOW or DENY,allowedValuesanddeniedValues must be unset. Setting this toALL_VALUES_UNSPECIFIEDallows for settingallowedValuesanddeniedValues`.

Enums
ALL_VALUES_UNSPECIFIED Indicates that allowedValues or deniedValues must be set.
ALLOW A policy with this set allows all values.
DENY A policy with this set denies all values.

BooleanPolicy

Used in policy_type to specify how booleanPolicy will behave at this resource.

JSON representation
{
  "enforced": boolean
}
Fields
enforced

boolean

If true, then the Policy is enforced. If false, then any configuration is acceptable.

Suppose you have a Constraint constraints/compute.disableSerialPortAccess with constraintDefault set to ALLOW. A Policy for that Constraint exhibits the following behavior: - If the Policy at this resource has enforced set to false, serial port connection attempts will be allowed. - If the Policy at this resource has enforced set to true, serial port connection attempts will be refused. - If the Policy at this resource is RestoreDefault, serial port connection attempts will be allowed. - If no Policy is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed. - If no Policy is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if thePolicy were set at this resource.

The following examples demonstrate the different possible layerings:

Example 1 (nearest Constraint wins): organizations/foo has a Policy with: {enforced: false} projects/bar has no Policy set. The constraint at projects/bar and organizations/foo will not be enforced.

Example 2 (enforcement gets replaced): organizations/foo has a Policy with: {enforced: false} projects/bar has a Policy with: {enforced: true} The constraint at organizations/foo is not enforced. The constraint at projects/bar is enforced.

Example 3 (RestoreDefault): organizations/foo has a Policy with: {enforced: true} projects/bar has a Policy with: {RestoreDefault: {}} The constraint at organizations/foo is enforced. The constraint at projects/bar is not enforced, because constraintDefault for the Constraint is ALLOW.

RestoreDefault

Ignores policies set above this resource and restores the constraintDefault enforcement behavior of the specific Constraint at this resource.

Suppose that constraintDefault is set to ALLOW for the Constraint constraints/serviceuser.services. Suppose that organization foo.com sets a Policy at their Organization resource node that restricts the allowed service activations to deny all service activations. They could then set a Policy with the policy_type restoreDefault on several experimental projects, restoring the constraintDefault enforcement of the Constraint for only those projects, allowing those projects to have all services activated.

AccessPolicy

AccessPolicy is a container for AccessLevels (which define the necessary attributes to use GCP services) and ServicePerimeters (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.

JSON representation
{
  "name": string,
  "parent": string,
  "title": string,
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Output only. Resource name of the AccessPolicy. Format: accessPolicies/{policyId}

parent

string

Required. The parent of this AccessPolicy in the Cloud Resource Hierarchy. Currently immutable once created. Format: organizations/{organizationId}

title

string

Required. Human readable title. Does not affect behavior.

createTime

string (Timestamp format)

Output only. time the AccessPolicy was created in UTC.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. time the AccessPolicy was updated in UTC.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

AccessLevel

An AccessLevel is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied.

JSON representation
{
  "name": string,
  "title": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "basic": {
    object (BasicLevel)
  }
}
Fields
name

string

Required. Resource name for the Access Level. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policyId}/accessLevels/{short_name}

title

string

Human readable title. Must be unique within the Policy.

description

string

description of the AccessLevel and its use. Does not affect behavior.

createTime

string (Timestamp format)

Output only. time the AccessLevel was created in UTC.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. time the AccessLevel was updated in UTC.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

basic

object (BasicLevel)

A BasicLevel composed of Conditions.

BasicLevel

BasicLevel is an AccessLevel using a set of recommended features.

JSON representation
{
  "conditions": [
    {
      object (Condition)
    }
  ],
  "combiningFunction": enum (ConditionCombiningFunction)
}
Fields
conditions[]

object (Condition)

Required. A list of requirements for the AccessLevel to be granted.

combiningFunction

enum (ConditionCombiningFunction)

How the conditions list should be combined to determine if a request is granted this AccessLevel. If AND is used, each Condition in conditions must be satisfied for the AccessLevel to be applied. If OR is used, at least one Condition in conditions must be satisfied for the AccessLevel to be applied. Default behavior is AND.

Condition

A condition necessary for an AccessLevel to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.

JSON representation
{
  "ipSubnetworks": [
    string
  ],
  "devicePolicy": {
    object (DevicePolicy)
  },
  "requiredAccessLevels": [
    string
  ],
  "negate": boolean,
  "members": [
    string
  ],
  "regions": [
    string
  ]
}
Fields
ipSubnetworks[]

string

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

devicePolicy

object (DevicePolicy)

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

requiredAccessLevels[]

string

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

negate

boolean

Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.

members[]

string

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

regions[]

string

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

DevicePolicy

DevicePolicy specifies device specific restrictions necessary to acquire a given access level. A DevicePolicy specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. DevicePolicy acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { osType : DESKTOP_WINDOWS, osType : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops.

JSON representation
{
  "requireScreenlock": boolean,
  "allowedEncryptionStatuses": [
    enum (DeviceEncryptionStatus)
  ],
  "osConstraints": [
    {
      object (OsConstraint)
    }
  ],
  "allowedDeviceManagementLevels": [
    enum (DeviceManagementLevel)
  ],
  "requireAdminApproval": boolean,
  "requireCorpOwned": boolean
}
Fields
requireScreenlock

boolean

Whether or not screenlock is required for the DevicePolicy to be true. Defaults to false.

allowedEncryptionStatuses[]

enum (DeviceEncryptionStatus)

Allowed encryptions statuses, an empty list allows all statuses.

osConstraints[]

object (OsConstraint)

Allowed OS versions, an empty list allows all types and all versions.

allowedDeviceManagementLevels[]

enum (DeviceManagementLevel)

Allowed device management levels, an empty list allows all management levels.

requireAdminApproval

boolean

Whether the device needs to be approved by the customer admin.

requireCorpOwned

boolean

Whether the device needs to be corp owned.

DeviceEncryptionStatus

The encryption state of the device.

Enums
ENCRYPTION_UNSPECIFIED The encryption status of the device is not specified or not known.
ENCRYPTION_UNSUPPORTED The device does not support encryption.
UNENCRYPTED The device supports encryption, but is currently unencrypted.
ENCRYPTED The device is encrypted.

OsConstraint

A restriction on the OS type and version of devices making requests.

JSON representation
{
  "osType": enum (OsType),
  "minimumVersion": string,
  "requireVerifiedChromeOs": boolean
}
Fields
osType

enum (OsType)

Required. The allowed OS type.

minimumVersion

string

The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: "major.minor.patch". Examples: "10.5.301", "9.2.1".

requireVerifiedChromeOs

boolean

Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to Dasher domain policies, and the caller has permission to call the API targeted by the request.

OsType

The operating system type of the device. Next id: 7

Enums
OS_UNSPECIFIED The operating system of the device is not specified or not known.
DESKTOP_MAC A desktop Mac operating system.
DESKTOP_WINDOWS A desktop Windows operating system.
DESKTOP_LINUX A desktop Linux operating system.
DESKTOP_CHROME_OS A desktop ChromeOS operating system.

DeviceManagementLevel

The degree to which the device is managed by the Cloud organization.

Enums
MANAGEMENT_UNSPECIFIED The device's management level is not specified or not known.
NONE The device is not managed.
BASIC Basic management is enabled, which is generally limited to monitoring and wiping the corporate account.
COMPLETE Complete device management. This includes more thorough monitoring and the ability to directly manage the device (such as remote wiping). This can be enabled through the Android Enterprise Platform.

ConditionCombiningFunction

options for how the conditions list should be combined to determine if this AccessLevel is applied. Default is AND.

Enums
AND All Conditions must be true for the BasicLevel to be true.
OR If at least one Condition is true, then the BasicLevel is true.

ServicePerimeter

ServicePerimeter describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the ServicePerimeter. If a request with a source within this ServicePerimeter has a target outside of the ServicePerimeter, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges.

JSON representation
{
  "name": string,
  "title": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "perimeterType": enum (PerimeterType),
  "status": {
    object (ServicePerimeterConfig)
  }
}
Fields
name

string

Required. Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policyId}/servicePerimeters/{short_name}

title

string

Human readable title. Must be unique within the Policy.

description

string

description of the ServicePerimeter and its use. Does not affect behavior.

createTime

string (Timestamp format)

Output only. time the ServicePerimeter was created in UTC.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. time the ServicePerimeter was updated in UTC.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

perimeterType

enum (PerimeterType)

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.

status

object (ServicePerimeterConfig)

Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.

PerimeterType

Specifies the type of the Perimeter. There are two types: regular and bridge. Regular Service Perimeter contains resources, access levels, and restricted services. Every resource can be in at most ONE regular Service Perimeter.

In addition to being in a regular service perimeter, a resource can also be in zero or more perimeter bridges. A perimeter bridge only contains resources. Cross project operations are permitted if all effected resources share some perimeter (whether bridge or regular). Perimeter Bridge does not contain access levels or services: those are governed entirely by the regular perimeter that resource is in.

Perimeter Bridges are typically useful when building more complex toplogies with many independent perimeters that need to share some data with a common perimeter, but should not be able to share data among themselves.

Enums
PERIMETER_TYPE_REGULAR Regular Perimeter.
PERIMETER_TYPE_BRIDGE Perimeter Bridge.

ServicePerimeterConfig

ServicePerimeterConfig specifies a set of GCP resources that describe specific Service Perimeter configuration.

JSON representation
{
  "resources": [
    string
  ],
  "accessLevels": [
    string
  ],
  "restrictedServices": [
    string
  ]
}
Fields
resources[]

string

A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{projectNumber}

accessLevels[]

string

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

restrictedServices[]

string

GCP services that are subject to the Service Perimeter restrictions. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

Try it!

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Cloud Asset Inventory Documentation