- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- StateSignal
- Try it!
Signals the state of a zone.
HTTP request
POST https://gdchardwaremanagement.googleapis.com/v1alpha/{name=projects/*/locations/*/zones/*}:signal
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the zone. Format: |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestId": string,
"stateSignal": enum ( |
Fields | |
---|---|
request |
Optional. An optional unique identifier for this request. See AIP-155. |
state |
Required. The state signal to send for this zone. |
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name
resource:
gdchardwaremanagement.zones.update
For more information, see the IAM documentation.
StateSignal
Valid state signals for a zone.
Enums | |
---|---|
STATE_SIGNAL_UNSPECIFIED |
State signal of the zone is unspecified. |
FACTORY_TURNUP_CHECKS_PASSED |
The Zone is ready for site turnup. |
READY_FOR_SITE_TURNUP |
The Zone is ready for site turnup. Deprecated, but not deleted. |
FACTORY_TURNUP_CHECKS_FAILED |
The Zone failed in factory turnup checks. |