Insert
|
|||||
|
|
Creates a Interconnect in the specified project using the data included in the request
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
Input
This building block consumes 35 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
requestId |
STRING |
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000) |
adminEnabled |
BOOLEAN |
Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true |
circuitInfos[] |
OBJECT |
Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 |
circuitInfos[].customerDemarcId |
STRING |
Customer-side demarc ID for this circuit |
circuitInfos[].googleCircuitId |
STRING |
Google-assigned unique ID for this circuit. Assigned at circuit turn-up |
circuitInfos[].googleDemarcId |
STRING |
Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA |
creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
customerName |
STRING |
Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect |
description |
STRING |
An optional description of this resource. Provide this property when you create the resource |
expectedOutages[] |
OBJECT |
Description of a planned outage on this Interconnect. Next id: 9 |
expectedOutages[].affectedCircuits[] |
STRING |
|
expectedOutages[].description |
STRING |
A description about the purpose of the outage |
expectedOutages[].endTime |
INTEGER |
Scheduled end time for the outage (milliseconds since Unix epoch) |
expectedOutages[].issueType |
ENUMERATION |
Form this outage is expected to take, which can take one of the following values:
|
expectedOutages[].name |
STRING |
Unique identifier for this outage notification |
expectedOutages[].source |
ENUMERATION |
The party that generated this notification, which can take the following value:
|
expectedOutages[].startTime |
INTEGER |
Scheduled start time for the outage (milliseconds since Unix epoch) |
expectedOutages[].state |
ENUMERATION |
State of this notification, which can take one of the following values:
|
googleIpAddress |
STRING |
[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests |
googleReferenceId |
STRING |
[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
interconnectAttachments[] |
STRING |
|
interconnectType |
ENUMERATION |
Type of interconnect, which can take one of the following values:
|
kind |
STRING |
[Output Only] Type of the resource. Always compute#interconnect for interconnects |
linkType |
ENUMERATION |
Type of link requested, which can take one of the following values:
|
location |
STRING |
URL of the InterconnectLocation object that represents where this connection is to be provisioned |
name |
STRING |
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 |
nocContactEmail |
STRING |
Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications |
operationalStatus |
ENUMERATION |
[Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
|
peerIpAddress |
STRING |
[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests |
provisionedLinkCount |
INTEGER |
[Output Only] Number of links actually provisioned in this interconnect |
requestedLinkCount |
INTEGER |
Target number of physical links in the link bundle, as requested by the customer |
selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
state |
ENUMERATION |
[Output Only] The current state of Interconnect functionality, which can take one of the following values:
|
= Parameter name
= Format
project STRING Required Project ID for this request |
requestId STRING An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000) |
adminEnabled BOOLEAN Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true |
circuitInfos[] OBJECT Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 |
circuitInfos[].customerDemarcId STRING Customer-side demarc ID for this circuit |
circuitInfos[].googleCircuitId STRING Google-assigned unique ID for this circuit. Assigned at circuit turn-up |
circuitInfos[].googleDemarcId STRING Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA |
creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
customerName STRING Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect |
description STRING An optional description of this resource. Provide this property when you create the resource |
expectedOutages[] OBJECT Description of a planned outage on this Interconnect. Next id: 9 |
expectedOutages[].affectedCircuits[] STRING |
expectedOutages[].description STRING A description about the purpose of the outage |
expectedOutages[].endTime INTEGER Scheduled end time for the outage (milliseconds since Unix epoch) |
expectedOutages[].issueType ENUMERATION Form this outage is expected to take, which can take one of the following values:
|
expectedOutages[].name STRING Unique identifier for this outage notification |
expectedOutages[].source ENUMERATION The party that generated this notification, which can take the following value:
|
expectedOutages[].startTime INTEGER Scheduled start time for the outage (milliseconds since Unix epoch) |
expectedOutages[].state ENUMERATION State of this notification, which can take one of the following values:
|
googleIpAddress STRING [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests |
googleReferenceId STRING [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
interconnectAttachments[] STRING |
interconnectType ENUMERATION Type of interconnect, which can take one of the following values:
|
kind STRING [Output Only] Type of the resource. Always compute#interconnect for interconnects |
linkType ENUMERATION Type of link requested, which can take one of the following values:
|
location STRING URL of the InterconnectLocation object that represents where this connection is to be provisioned |
name STRING 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 |
nocContactEmail STRING Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications |
operationalStatus ENUMERATION [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
|
peerIpAddress STRING [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests |
provisionedLinkCount INTEGER [Output Only] Number of links actually provisioned in this interconnect |
requestedLinkCount INTEGER Target number of physical links in the link bundle, as requested by the customer |
selfLink STRING [Output Only] Server-defined URL for the resource |
state ENUMERATION [Output Only] The current state of Interconnect functionality, which can take one of the following values:
|
Output
This building block provides 32 output parameters
Name | Format | Description |
---|---|---|
clientOperationId |
STRING |
[Output Only] The value of |
creationTimestamp |
STRING |
[Deprecated] This field is deprecated |
description |
STRING |
[Output Only] A textual description of the operation, which is set when the operation is created |
endTime |
STRING |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format |
error |
OBJECT |
[Output Only] If errors are generated during processing of the operation, this field will be populated |
error.errors[] |
OBJECT |
|
error.errors[].code |
STRING |
[Output Only] The error type identifier for this error |
error.errors[].location |
STRING |
[Output Only] Indicates the field in the request that caused the error. This property is optional |
error.errors[].message |
STRING |
[Output Only] An optional, human-readable error message |
httpErrorMessage |
STRING |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND |
httpErrorStatusCode |
INTEGER |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
insertTime |
STRING |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format |
kind |
STRING |
[Output Only] Type of the resource. Always compute#operation for Operation resources |
name |
STRING |
[Output Only] Name of the resource |
operationType |
STRING |
[Output Only] The type of operation, such as insert, update, or delete, and so on |
progress |
INTEGER |
[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses |
region |
STRING |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations |
selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
startTime |
STRING |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format |
status |
ENUMERATION |
[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE |
statusMessage |
STRING |
[Output Only] An optional textual description of the current status of the operation |
targetId |
INTEGER |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource |
targetLink |
STRING |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from |
user |
STRING |
[Output Only] User who requested the operation, for example: [email protected] |
warnings[] |
OBJECT |
|
warnings[].code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] |
OBJECT |
|
warnings[].data[].key |
STRING |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warnings[].data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
warnings[].message |
STRING |
[Output Only] A human-readable description of the warning code |
zone |
STRING |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations |
= Parameter name
= Format
clientOperationId STRING [Output Only] The value of |
creationTimestamp STRING [Deprecated] This field is deprecated |
description STRING [Output Only] A textual description of the operation, which is set when the operation is created |
endTime STRING [Output Only] The time that this operation was completed. This value is in RFC3339 text format |
error OBJECT [Output Only] If errors are generated during processing of the operation, this field will be populated |
error.errors[] OBJECT |
error.errors[].code STRING [Output Only] The error type identifier for this error |
error.errors[].location STRING [Output Only] Indicates the field in the request that caused the error. This property is optional |
error.errors[].message STRING [Output Only] An optional, human-readable error message |
httpErrorMessage STRING [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND |
httpErrorStatusCode INTEGER [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
insertTime STRING [Output Only] The time that this operation was requested. This value is in RFC3339 text format |
kind STRING [Output Only] Type of the resource. Always compute#operation for Operation resources |
name STRING [Output Only] Name of the resource |
operationType STRING [Output Only] The type of operation, such as insert, update, or delete, and so on |
progress INTEGER [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses |
region STRING [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations |
selfLink STRING [Output Only] Server-defined URL for the resource |
startTime STRING [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format |
status ENUMERATION [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE |
statusMessage STRING [Output Only] An optional textual description of the current status of the operation |
targetId INTEGER [Output Only] The unique target ID, which identifies a specific incarnation of the target resource |
targetLink STRING [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from |
user STRING [Output Only] User who requested the operation, for example: [email protected] |
warnings[] OBJECT |
warnings[].code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] OBJECT |
warnings[].data[].key STRING [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warnings[].data[].value STRING [Output Only] A warning data value corresponding to the key |
warnings[].message STRING [Output Only] A human-readable description of the warning code |
zone STRING [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations |