Skip to main content

Retrieving the Data Source

This data source can be retrieved by one of ID or one of additional getters.
Retrieve by ID
To retrieve by ID, fill in only the id field:
data ... {
    id = "your-ID"
}
Retrieve by Additional Getters
To retrieve by one of additional getters, fill in one of these fields: by_resource_affinity, leaving other fields unset.
data ... {
    getter_name = {
        ...
	 }
}
see the schema for more details on each field. Capacity Block Group is a parent resource for Capacity Intervals.

Schema

Optional

  • by_resource_affinity (Attributes) : Get Capacity Block Group by its specification.

    Inner value description

    Get a Capacity Block Group in a Tenant by its Resource Affinity. (see below for nested schema)
  • id (String) Identifier for the resource, unique for its resource type.

Read-Only

  • created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • labels (Map of String) : Labels associated with the resource.
  • metadata (Attributes) :

    Inner value description

    Common resource metadata. (see below for nested schema)
  • name (String) Human readable name for the resource.
  • parent_id (String) Identifier of the parent resource to which the resource belongs.
  • resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
  • status (Attributes) :

    Inner value description

    Capacity Block Group status. (see below for nested schema)
  • updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

Nested Schema for by_resource_affinity

Required:
  • parent_id (String) Tenant ID of the Capacity Block Group.
  • region (String) : Name of the region where the Capacity Block Group is allocated. Example: “eu-north1”.
  • resource_affinity (Attributes) : Specifications of the Capacity Block Group.

    Inner value description

    Specification of the Capacity Block Group. (see below for nested schema)

Nested Schema for by_resource_affinity.resource_affinity

Optional:
  • compute_v1 (Attributes) : First version of the compute Resource Affinity.

    Inner value description

    First version of Compute service resource affinity (see below for nested schema)

Nested Schema for by_resource_affinity.resource_affinity.compute_v1

Required:
  • platform (String) The platform for which the Capacity Block Group is allocated.
Optional:
  • fabric (String) The fabric where the Capacity Block Group is allocated.

Nested Schema for metadata

Nested Schema for status

Read-Only:
  • current_continuous_interval (Attributes) : Current concatenation of non-zero Capacity Intervals that overlap or follow each other without a break. If all Capacity Intervals are in the past, returns the last Continuous Interval. If all Capacity Intervals are in the future, returns the first Continuous Interval scheduled.

    Inner value description

    Current, last or future concatenation of Capacity Intervals in a Capacity Block Group. (see below for nested schema)
  • current_limit (Number) Capacity Block Group current quota limit.
  • next_change_at (String) : Time of the next Capacity Block Group quota change. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • next_change_to (Number) : The next expected change of the Capacity Block Group quota limit. the quota limit change that is currently performed.
  • reconciling (Boolean) Shows that changes are in flight.
  • region (String) : Name of the region where the Capacity Block Group is allocated. Example: “eu-north1”.
  • resource_affinity (Attributes) : Specification of the Capacity Block Group.

    Inner value description

    Specification of the Capacity Block Group. (see below for nested schema)
  • service (String) Service for which the Capacity Block Group is allocated.
  • state (String) : Capacity Block Group state with respect to quota allocation.

    Supported values

    Shows the state of a Capacity Block Group with respect to its quota. Possible values:
    • STATE_UNSPECIFIED - Shouldn’t happen.
    • STATE_ALLOCATING - Capacity Block Group quota is being allocated as one or more capacity intervals have started.
    • STATE_ACTIVE - Capacity Block Group quota is already allocated and active as one or more capacity intervals are active.
    • STATE_SHUTTING - Capacity Block Group is being shut down due to absence of active intervals at the time.
    • STATE_INACTIVE - Capacity Block Group is inactive due to absence of active intervals at the time.
  • usage (Number) Capacity Block Group quota usage.
  • usage_percentage (String) Capacity Block Group quota usage percentage.
  • usage_state (String) : Capacity Block Group quota usage state.

    Supported values

    Shows the usage state if a Capacity Block Group quota. Possible values:
    • USAGE_STATE_UNSPECIFIED - Shouldn’t happen.
    • USAGE_STATE_USED - Capacity Block Group quota is actively in use.
    • USAGE_STATE_NOT_USED - Capacity Block Group quota is not currently in use.
    • USAGE_STATE_UNKNOWN: Capacity Block Group region is unreachable, the current usage is therefore unknown. Please, retry the request later.

Nested Schema for status.current_continuous_interval

Read-Only:
  • end_time (String) : End time of the last interval(s) in Continuous Interval. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • quantity (Number) : Quota quantity that is currently set, was set or will be set in the Continuous Interval depending on it’s start_time and end_time. If the Continuous Interval is currently active, quantity is the sum of quantities of the currently active non-zero intervals. If the Continuous Interval is in the past, quantity is the sum of quantities of the last non-zero active intervals. If the Continuous Interval is in the future, quantity is the sum of the quantities of the first scheduled non-zero active intervals.
  • start_time (String) : Start time of the first interval(s) in Continuous Interval. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • state (String) : Continuous Interval state.

    Supported values

    Shows a state of a Continuous Interval. Possible values:
    • STATE_UNSPECIFIED - Shouldn’t happen.
    • STATE_SCHEDULED - Continuous Interval is in the future.
    • STATE_ACTIVE - Continuous Interval is active.
    • STATE_EXPIRED - Continuous Interval is in the past.

Nested Schema for status.resource_affinity

Read-Only:
  • compute_v1 (Attributes) : First version of the compute Resource Affinity.

    Inner value description

    First version of Compute service resource affinity (see below for nested schema)

Nested Schema for status.resource_affinity.compute_v1

Read-Only:
  • fabric (String) The fabric where the Capacity Block Group is allocated.
  • platform (String) The platform for which the Capacity Block Group is allocated.