Method: interconnectAttachmentGroups.getOperationalStatus

Returns the InterconnectAttachmentStatuses for the specified InterconnectAttachmentGroup resource.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`interconnectAttachmentGroup`	`string` Name of the interconnectAttachmentGroup resource to query.

project

string

Project ID for this request.

interconnectAttachmentGroup

string

Name of the interconnectAttachmentGroup resource to query.

Request body

The request body must be empty.

Response body

Response for the InterconnectAttachmentGroupsGetOperationalStatusResponse.

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

JSON representation
{ "result": { "groupStatus": enum, "attachmentStatuses": [ { "attachment": string, "isActive": enum, "adminEnabled": boolean, "status": enum } ], "intent": { "availabilitySla": enum }, "configured": { "availabilitySla": { "effectiveSla": enum, "intendedSlaBlockers": [ { "blockerType": enum, "explanation": string, "documentationLink": string, "regions": [ string ], "metros": [ string ], "zones": [ string ], "attachments": [ string ] } ] } }, "operational": { "availabilitySla": { "effectiveSla": enum, "intendedSlaBlockers": [ { "blockerType": enum, "explanation": string, "documentationLink": string, "regions": [ string ], "metros": [ string ], "zones": [ string ], "attachments": [ string ] } ] } } }, "etag": string }

JSON representation

{
  "result": {
    "groupStatus": enum,
    "attachmentStatuses": [
      {
        "attachment": string,
        "isActive": enum,
        "adminEnabled": boolean,
        "status": enum
      }
    ],
    "intent": {
      "availabilitySla": enum
    },
    "configured": {
      "availabilitySla": {
        "effectiveSla": enum,
        "intendedSlaBlockers": [
          {
            "blockerType": enum,
            "explanation": string,
            "documentationLink": string,
            "regions": [
              string
            ],
            "metros": [
              string
            ],
            "zones": [
              string
            ],
            "attachments": [
              string
            ]
          }
        ]
      }
    },
    "operational": {
      "availabilitySla": {
        "effectiveSla": enum,
        "intendedSlaBlockers": [
          {
            "blockerType": enum,
            "explanation": string,
            "documentationLink": string,
            "regions": [
              string
            ],
            "metros": [
              string
            ],
            "zones": [
              string
            ],
            "attachments": [
              string
            ]
          }
        ]
      }
    }
  },
  "etag": string
}

Fields
`result`	`object`
`result.groupStatus`	`enum` Summarizes the status of the group.
`result.attachmentStatuses[]`	`object`
`result.attachmentStatuses[].attachment`	`string` The URL of the Attachment being described.
`result.attachmentStatuses[].isActive`	`enum` Whether this Attachment is participating in the redundant configuration. This will be ACTIVE if and only if the status below is CONNECTION_UP. Any INACTIVE Attachments are excluded from the analysis that generates operational.availabilitySLA.
`result.attachmentStatuses[].adminEnabled`	`boolean` Whether this Attachment is enabled. This becomes false when the customer drains their Attachment.
`result.attachmentStatuses[].status`	`enum` Whether this Attachment is active, and if so, whether BGP is up.
`result.intent`	`object`
`result.intent.availabilitySla`	`enum`
`result.configured`	`object`
`result.configured.availabilitySla`	`object`
`result.configured.availabilitySla.effectiveSla`	`enum`
`result.configured.availabilitySla.intendedSlaBlockers[]`	`object`
`result.configured.availabilitySla.intendedSlaBlockers[].blockerType`	`enum`
`result.configured.availabilitySla.intendedSlaBlockers[].explanation`	`string` [Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement.
`result.configured.availabilitySla.intendedSlaBlockers[].documentationLink`	`string` [Output Only] The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement.
`result.configured.availabilitySla.intendedSlaBlockers[].regions[]`	`string` [Output Only] Regions used to explain this blocker in more detail. These are region names formatted like "us-central1". This will be set for some blockers (like INCOMPATIBLE_REGIONS) but does not apply to others.
`result.configured.availabilitySla.intendedSlaBlockers[].metros[]`	`string` [Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like "iad". This will be set for some blockers (like NO_ATTACHMENTS_IN_METRO_AND_ZONE) but does not apply to others.
`result.configured.availabilitySla.intendedSlaBlockers[].zones[]`	`string` [Output Only] Zones used to explain this blocker in more detail. Format is "zone1" and/or "zone2". This will be set for some blockers (like MISSING_ZONE) but does not apply to others.
`result.configured.availabilitySla.intendedSlaBlockers[].attachments[]`	`string` [Output Only] URLs of any particular Attachments to explain this blocker in more detail.
`result.operational`	`object` The operational state of the group, including only active Attachments.
`result.operational.availabilitySla`	`object`
`result.operational.availabilitySla.effectiveSla`	`enum`
`result.operational.availabilitySla.intendedSlaBlockers[]`	`object`
`result.operational.availabilitySla.intendedSlaBlockers[].blockerType`	`enum`
`result.operational.availabilitySla.intendedSlaBlockers[].explanation`	`string` [Output Only] A human-readable explanation of this requirement and why it's not met. This is set for every type of requirement.
`result.operational.availabilitySla.intendedSlaBlockers[].documentationLink`	`string` [Output Only] The url of Google Cloud public documentation explaining this requirement. This is set for every type of requirement.
`result.operational.availabilitySla.intendedSlaBlockers[].regions[]`	`string` [Output Only] Regions used to explain this blocker in more detail. These are region names formatted like "us-central1". This will be set for some blockers (like INCOMPATIBLE_REGIONS) but does not apply to others.
`result.operational.availabilitySla.intendedSlaBlockers[].metros[]`	`string` [Output Only] Metros used to explain this blocker in more detail. These are three-letter lowercase strings like "iad". This will be set for some blockers (like NO_ATTACHMENTS_IN_METRO_AND_ZONE) but does not apply to others.
`result.operational.availabilitySla.intendedSlaBlockers[].zones[]`	`string` [Output Only] Zones used to explain this blocker in more detail. Format is "zone1" and/or "zone2". This will be set for some blockers (like MISSING_ZONE) but does not apply to others.
`result.operational.availabilitySla.intendedSlaBlockers[].attachments[]`	`string` [Output Only] URLs of any particular Attachments to explain this blocker in more detail.
`etag`	`string`

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute.readonly
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.interconnectAttachmentGroups.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.

Method: interconnectAttachmentGroups.getOperationalStatus Stay organized with collections Save and categorize content based on your preferences.