- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Gets the specified wire group resource in the given scope.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
cross |
|
wire |
Name of the wire group resource to return. |
Request body
The request body must be empty.
Response body
A resource that represents a group of redundant wires.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "selfLink": string, "selfLinkWithId": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "endpoints": { string: { "interconnects": { string: { "interconnect": string, "vlanTags": [ integer ] }, ... } }, ... }, "wireGroupProperties": { "type": enum }, "wireProperties": { "bandwidthUnmetered": string, "faultResponse": enum }, "adminEnabled": boolean, "wires": [ { "label": string, "endpoints": [ { "interconnect": string, "vlanTag": integer } ], "wireProperties": { "bandwidthUnmetered": string, "faultResponse": enum }, "adminEnabled": boolean } ], "topology": { "endpoints": [ { "label": string, "city": string } ] } } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
self |
[Output Only] Server-defined URL for the resource. |
self |
|
id |
[Output Only] The unique identifier for the resource type. The server generates this identifier. |
creation |
[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 the wire group. |
endpoints[] |
A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows:
|
endpoints[]. |
A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows:
|
endpoints[]. |
An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs:
global/interconnects/NAME projects/PROJECT_ID/global/interconnects/NAME |
endpoints[]. |
To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from
|
wire |
Properties of the wire group. |
wire |
The type of the wire group, one of the following:
|
wire |
Properties for all wires in the wire group. |
wire |
The unmetered bandwidth in Gigabits per second, using decimal units. |
wire |
Response when a fault is detected in a pseudowire:
|
admin |
Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of |
wires[] |
The single/redundant wire(s) managed by the wire group. |
wires[]. |
[Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows:
|
wires[]. |
Wire endpoints are specific Interconnect connections. |
wires[]. |
|
wires[]. |
|
wires[]. |
[Output Only] Properties of the wire. |
wires[]. |
The unmetered bandwidth in Gigabits per second, using decimal units. |
wires[]. |
Response when a fault is detected in a pseudowire:
|
wires[]. |
[Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true. |
topology |
Topology details for the wire group configuration. |
topology. |
Topology details for all endpoints in the wire group. |
topology. |
Endpoint label from the wire group. |
topology. |
The InterconnectLocation.city (metropolitan area designator) that all interconnects are located in. |
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.wireGroups.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.