mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-19 07:15:23 +00:00
gcloud: Thu Dec 14 10:23:57 UTC 2023
This commit is contained in:
parent
f36750d203
commit
a990278fb3
205 changed files with 4929 additions and 1866 deletions
323
gcloud/alpha/monitoring/uptime/create
Normal file
323
gcloud/alpha/monitoring/uptime/create
Normal file
|
|
@ -0,0 +1,323 @@
|
|||
NAME
|
||||
gcloud alpha monitoring uptime create - create a new uptime check
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring uptime create DISPLAY_NAME
|
||||
(--synthetic-target=SYNTHETIC_TARGET
|
||||
| [--group-id=GROUP_ID : --group-type=GROUP_TYPE]
|
||||
| [--resource-labels=[KEY=VALUE,...]
|
||||
: --resource-type=RESOURCE_TYPE])
|
||||
[--body=BODY --content-type=CONTENT_TYPE
|
||||
--custom-content-type=CUSTOM_CONTENT_TYPE --headers=[KEY=VALUE,...]
|
||||
--mask-headers=MASK_HEADERS --password=PASSWORD --path=PATH
|
||||
--pings-count=PINGS_COUNT --port=PORT --protocol=PROTOCOL
|
||||
--request-method=REQUEST_METHOD --username=USERNAME
|
||||
--validate-ssl=VALIDATE_SSL --status-classes=[status-class,...]
|
||||
| --status-codes=[status-code,...]]
|
||||
[--matcher-content=MATCHER_CONTENT
|
||||
: --matcher-type=MATCHER_TYPE [--json-path=JSON_PATH
|
||||
: --json-path-matcher-type=JSON_PATH_MATCHER_TYPE]]
|
||||
[--period=PERIOD --regions=[field,...]
|
||||
--timeout=TIMEOUT --user-labels=[KEY=VALUE,...]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Create a new uptime check.
|
||||
|
||||
For information about the JSON/YAML format of an uptime check:
|
||||
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.uptimeCheckConfigs
|
||||
|
||||
EXAMPLES
|
||||
To create an uptime check against an uptime_url, run:
|
||||
|
||||
$ gcloud alpha monitoring uptime create DISPLAY_NAME \
|
||||
--resource-type=uptime-url \
|
||||
--resource-labels=host=google.com,project_id=PROJECT_ID
|
||||
|
||||
To create a synthetic monitor, run:
|
||||
|
||||
$ gcloud alpha monitoring uptime create fake_uptime_check \
|
||||
--synthetic-target=projects/PROJECT_ID/locations/REGION/\
|
||||
functions/FUNCTION_NAME
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
DISPLAY_NAME
|
||||
Display name for the Uptime Check.
|
||||
|
||||
REQUIRED FLAGS
|
||||
Uptime check resource
|
||||
|
||||
Exactly one of these must be specified:
|
||||
|
||||
--synthetic-target=SYNTHETIC_TARGET
|
||||
The target of the Synthetic Monitor. This is the fully qualified
|
||||
GCFv2 resource name.
|
||||
|
||||
Monitored resource group
|
||||
|
||||
--group-id=GROUP_ID
|
||||
The group of resources being monitored.
|
||||
|
||||
This flag argument must be specified if any of the other arguments
|
||||
in this group are specified.
|
||||
|
||||
--group-type=GROUP_TYPE
|
||||
The resource type of the group members, defaults to "gce-instance".
|
||||
GROUP_TYPE must be one of:
|
||||
|
||||
aws-elb-load-balancer
|
||||
Uptime Check against a group of Amazon ELB load balancers.
|
||||
gce-instance
|
||||
Uptime Check against a group of instances from Google Cloud or
|
||||
Amazon Web Services.
|
||||
|
||||
Monitored resource
|
||||
|
||||
--resource-labels=[KEY=VALUE,...]
|
||||
Values for all of the labels listed in the associated monitored
|
||||
resource descriptor. See
|
||||
https://cloud.google.com/monitoring/api/resources for more
|
||||
information and allowed keys.
|
||||
|
||||
This flag argument must be specified if any of the other arguments
|
||||
in this group are specified.
|
||||
|
||||
--resource-type=RESOURCE_TYPE
|
||||
Type of monitored resource, defaults to "uptime-url". RESOURCE_TYPE
|
||||
must be one of:
|
||||
|
||||
aws-ec2-instance
|
||||
Uptime Check against an AWS EC2 instance.
|
||||
aws-elb-load-balancer
|
||||
Uptime Check against an ElasticLoadBalancer.
|
||||
cloud-run-revision
|
||||
Uptime Check against a Cloud Run revision.
|
||||
gae-app
|
||||
Uptime Check against an App Engine module.
|
||||
gce-instance
|
||||
Uptime Check against a Compute Engine instance.
|
||||
servicedirectory-service
|
||||
Uptime Check against a Service Directory service.
|
||||
uptime-url
|
||||
Uptime Check against a URL.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
Uptime check protocol settings
|
||||
|
||||
--body=BODY
|
||||
The request body associated with the HTTP POST request. Can only be
|
||||
set if --protocol is "http" or "https".
|
||||
|
||||
--content-type=CONTENT_TYPE
|
||||
The content type header to use for the check, defaults to
|
||||
"unspecified". Can only be set if --protocol is "http" or "https".
|
||||
|
||||
CONTENT_TYPE must be one of:
|
||||
|
||||
unspecified
|
||||
Not specified
|
||||
url-encoded
|
||||
URL encoded
|
||||
user-provided
|
||||
User provided
|
||||
|
||||
--custom-content-type=CUSTOM_CONTENT_TYPE
|
||||
A user-provided content type header to use for the check. Can only be
|
||||
set if --protocol is "http" or "https".
|
||||
|
||||
--headers=[KEY=VALUE,...]
|
||||
The list of headers to send as part of the Uptime Check request. Can
|
||||
only be set if --protocol is "http" or "https".
|
||||
|
||||
--mask-headers=MASK_HEADERS
|
||||
Whether to encrypt the header information, defaults to "false". Can
|
||||
only be set if --protocol is "http" or "https".
|
||||
|
||||
--password=PASSWORD
|
||||
The password to use when authenticating with the HTTP server. Can
|
||||
only be set if --protocol is "http" or "https".
|
||||
|
||||
--path=PATH
|
||||
The path to the page against which to run the check, defaults to "/".
|
||||
Can only be set if --protocol is "http" or "https".
|
||||
|
||||
--pings-count=PINGS_COUNT
|
||||
Number of ICMP pings to send alongside the request.
|
||||
|
||||
--port=PORT
|
||||
The port on the server against which to run the check. Defaults to
|
||||
"80" when --protocol is "http". Defaults to "443" when --protocol is
|
||||
"https". Required if --protocol is "tcp".
|
||||
|
||||
--protocol=PROTOCOL
|
||||
The protocol of the request, defaults to "http". PROTOCOL must be one
|
||||
of:
|
||||
|
||||
http
|
||||
An HTTP check.
|
||||
https
|
||||
An HTTPS check.
|
||||
tcp
|
||||
A TCP check.
|
||||
|
||||
--request-method=REQUEST_METHOD
|
||||
The HTTP request method to use, defaults to "get". Can only be set if
|
||||
--protocol is "http" or "https".
|
||||
|
||||
REQUEST_METHOD must be one of:
|
||||
|
||||
get
|
||||
HTTP GET method
|
||||
post
|
||||
HTTP POST method
|
||||
|
||||
--username=USERNAME
|
||||
The username to use when authenticating with the HTTP server. Can
|
||||
only be set if --protocol is "http" or "https".
|
||||
|
||||
--validate-ssl=VALIDATE_SSL
|
||||
Whether to include SSL certificate validation as a part of the Uptime
|
||||
Check, defaults to "false". Can only be set if --protocol is "https".
|
||||
|
||||
Uptime Status
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--status-classes=[status-class,...]
|
||||
List of HTTP Status Classes. The Uptime Check will only pass if the
|
||||
response code is contained in this list. Defaults to "2xx". Can
|
||||
only be set if --protocol is "http" or "https".
|
||||
|
||||
status-class must be one of:
|
||||
|
||||
1xx
|
||||
Any response code from 100-199 inclusive
|
||||
2xx
|
||||
Any response code from 200-299 inclusive
|
||||
3xx
|
||||
Any response code from 300-399 inclusive
|
||||
4xx
|
||||
Any response code from 400-499 inclusive
|
||||
5xx
|
||||
Any response code from 500-599 inclusive
|
||||
any
|
||||
Any response code
|
||||
|
||||
--status-codes=[status-code,...]
|
||||
List of HTTP Status Codes. The Uptime Check will only pass if the
|
||||
response code is present in this list. Can only be set if
|
||||
--protocol is "http" or "https".
|
||||
|
||||
Uptime matcher settings
|
||||
|
||||
--matcher-content=MATCHER_CONTENT
|
||||
String, regex or JSON content to match.
|
||||
|
||||
This flag argument must be specified if any of the other arguments in
|
||||
this group are specified.
|
||||
|
||||
--matcher-type=MATCHER_TYPE
|
||||
The type of content matcher that will be applied to the server
|
||||
output, defaults to "contains-string".
|
||||
|
||||
MATCHER_TYPE must be one of:
|
||||
|
||||
contains-string
|
||||
Response contains string
|
||||
matches-json-path
|
||||
Response matches at JSONPath
|
||||
matches-regex
|
||||
Response matches regex
|
||||
not-contains-string
|
||||
Response does not contain string
|
||||
not-matches-json-path
|
||||
Response does not match at JSONPath
|
||||
not-matches-regex
|
||||
Response does not match regex
|
||||
|
||||
Uptime matcher settings for JSON responses
|
||||
|
||||
--json-path=JSON_PATH
|
||||
JSONPath within the response output pointing to the expected
|
||||
content to match. Only used if matcher-type is "matches-json-path"
|
||||
or "not-matches-json-path".
|
||||
|
||||
This flag argument must be specified if any of the other arguments
|
||||
in this group are specified.
|
||||
|
||||
--json-path-matcher-type=JSON_PATH_MATCHER_TYPE
|
||||
The type of JSONPath match that will be applied to the JSON output,
|
||||
defaults to "exact-match". Only used if matcher-type is
|
||||
"matches-json-path" or "not-matches-json-path".
|
||||
|
||||
JSON_PATH_MATCHER_TYPE must be one of:
|
||||
|
||||
exact-match
|
||||
Response matches exact string at JSONPath
|
||||
regex-match
|
||||
Response matches regex at JSONPath
|
||||
|
||||
Uptime check settings
|
||||
|
||||
--period=PERIOD
|
||||
How often, in minutes, the Uptime check is performed, defaults to
|
||||
"1". PERIOD must be one of:
|
||||
|
||||
1
|
||||
One minute
|
||||
10
|
||||
Ten minutes
|
||||
15
|
||||
Fifteen minutes
|
||||
5
|
||||
Five minutes
|
||||
|
||||
--regions=[field,...]
|
||||
The list of regions from which the check will be run. At least 3
|
||||
regions must be selected. Defaults to all available regions.
|
||||
|
||||
field must be one of:
|
||||
|
||||
asia-pacific
|
||||
asia-southeast1
|
||||
europe
|
||||
europe-west1
|
||||
south-america
|
||||
southamerica-east1
|
||||
usa-iowa
|
||||
us-central1
|
||||
usa-oregon
|
||||
us-west1
|
||||
usa-virginia
|
||||
us-east4
|
||||
|
||||
--timeout=TIMEOUT
|
||||
The maximum amount of time in seconds to wait for the request to
|
||||
complete, defaults to "60".
|
||||
|
||||
--user-labels=[KEY=VALUE,...]
|
||||
List of label KEY=VALUE pairs to add.
|
||||
|
||||
Keys must start with a lowercase character and contain only hyphens
|
||||
(-), underscores (_), lowercase characters, and numbers. Values must
|
||||
contain only hyphens (-), underscores (_), lowercase characters, and
|
||||
numbers.
|
||||
|
||||
If the uptime check was given as a JSON/YAML object from a string or
|
||||
file, this flag will replace the labels value in the given uptime
|
||||
check.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
--billing-project, --configuration, --flags-file, --flatten, --format,
|
||||
--help, --impersonate-service-account, --log-http, --project, --quiet,
|
||||
--trace-token, --user-output-enabled, --verbosity.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
NOTES
|
||||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
|
||||
55
gcloud/alpha/monitoring/uptime/delete
Normal file
55
gcloud/alpha/monitoring/uptime/delete
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
NAME
|
||||
gcloud alpha monitoring uptime delete - delete an uptime check
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring uptime delete CHECK_ID [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Delete an uptime check
|
||||
|
||||
EXAMPLES
|
||||
To delete an uptime check:
|
||||
|
||||
$ gcloud alpha monitoring uptime delete check-id
|
||||
|
||||
More information can be found at
|
||||
https://cloud.google.com/monitoring/uptime-checks/manage#delete.
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Uptime check resource - The uptime check to delete. This represents a
|
||||
Cloud resource. (NOTE) Some attributes are not given arguments in this
|
||||
group but can be set in other ways.
|
||||
|
||||
To set the project attribute:
|
||||
◆ provide the argument check_id on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
CHECK_ID
|
||||
ID of the uptime_check or fully qualified identifier for the
|
||||
uptime_check.
|
||||
|
||||
To set the check_id attribute:
|
||||
▸ provide the argument check_id on the command line.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
--billing-project, --configuration, --flags-file, --flatten, --format,
|
||||
--help, --impersonate-service-account, --log-http, --project, --quiet,
|
||||
--trace-token, --user-output-enabled, --verbosity.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
API REFERENCE
|
||||
This command uses the monitoring/v3 API. The full documentation for this
|
||||
API can be found at: https://cloud.google.com/monitoring/api/
|
||||
|
||||
NOTES
|
||||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
|
||||
55
gcloud/alpha/monitoring/uptime/describe
Normal file
55
gcloud/alpha/monitoring/uptime/describe
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
NAME
|
||||
gcloud alpha monitoring uptime describe - describe an uptime check
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring uptime describe CHECK_ID [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Describe an uptime check
|
||||
|
||||
EXAMPLES
|
||||
To describe an uptime check:
|
||||
|
||||
$ gcloud alpha monitoring uptime describe
|
||||
|
||||
More information can be found at
|
||||
https://cloud.google.com/monitoring/uptime-checks/manage#get.
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Uptime check resource - The uptime check to describe. This represents a
|
||||
Cloud resource. (NOTE) Some attributes are not given arguments in this
|
||||
group but can be set in other ways.
|
||||
|
||||
To set the project attribute:
|
||||
◆ provide the argument check_id on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
CHECK_ID
|
||||
ID of the uptime_check or fully qualified identifier for the
|
||||
uptime_check.
|
||||
|
||||
To set the check_id attribute:
|
||||
▸ provide the argument check_id on the command line.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
--billing-project, --configuration, --flags-file, --flatten, --format,
|
||||
--help, --impersonate-service-account, --log-http, --project, --quiet,
|
||||
--trace-token, --user-output-enabled, --verbosity.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
API REFERENCE
|
||||
This command uses the monitoring/v3 API. The full documentation for this
|
||||
API can be found at: https://cloud.google.com/monitoring/api/
|
||||
|
||||
NOTES
|
||||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
|
||||
|
|
@ -18,9 +18,24 @@ GCLOUD WIDE FLAGS
|
|||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
create
|
||||
(ALPHA) Create a new uptime check.
|
||||
|
||||
delete
|
||||
(ALPHA) Delete an uptime check.
|
||||
|
||||
describe
|
||||
(ALPHA) Describe an uptime check.
|
||||
|
||||
list-configs
|
||||
(ALPHA) List uptime checks.
|
||||
|
||||
list-ips
|
||||
(ALPHA) List uptime check egress ips.
|
||||
|
||||
update
|
||||
(ALPHA) Update an existing uptime check.
|
||||
|
||||
NOTES
|
||||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
|
|
|
|||
69
gcloud/alpha/monitoring/uptime/list-configs
Normal file
69
gcloud/alpha/monitoring/uptime/list-configs
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
NAME
|
||||
gcloud alpha monitoring uptime list-configs - list uptime checks
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring uptime list-configs [--filter=EXPRESSION]
|
||||
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) List uptime checks.
|
||||
|
||||
EXAMPLES
|
||||
To see all uptime checks:
|
||||
|
||||
$ gcloud alpha monitoring uptime list-configs
|
||||
|
||||
More information can be found at
|
||||
https://cloud.google.com/monitoring/uptime-checks/using-uptime-checks
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--page-size=PAGE_SIZE
|
||||
Some services group resource list output into pages. This flag
|
||||
specifies the maximum number of resources per page. The default is
|
||||
determined by the service if it supports paging, otherwise it is
|
||||
unlimited (no paging). Paging may be applied before or after --filter
|
||||
and --limit depending on the service.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--uri
|
||||
Print a list of resource URIs instead of the default output, and change
|
||||
the command output to a list of URIs. If this flag is used with
|
||||
--format, the formatting is applied on this URI list. To display URIs
|
||||
alongside other keys instead, use the uri() transform.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
--billing-project, --configuration, --flags-file, --flatten, --format,
|
||||
--help, --impersonate-service-account, --log-http, --project, --quiet,
|
||||
--trace-token, --user-output-enabled, --verbosity.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
API REFERENCE
|
||||
This command uses the monitoring/v3 API. The full documentation for this
|
||||
API can be found at: https://cloud.google.com/monitoring/api/
|
||||
|
||||
NOTES
|
||||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
|
||||
397
gcloud/alpha/monitoring/uptime/update
Normal file
397
gcloud/alpha/monitoring/uptime/update
Normal file
|
|
@ -0,0 +1,397 @@
|
|||
NAME
|
||||
gcloud alpha monitoring uptime update - update an existing uptime check
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha monitoring uptime update CHECK_ID
|
||||
[--body=BODY --content-type=CONTENT_TYPE
|
||||
--custom-content-type=CUSTOM_CONTENT_TYPE --mask-headers=MASK_HEADERS
|
||||
--password=PASSWORD --path=PATH --pings-count=PINGS_COUNT --port=PORT
|
||||
--request-method=REQUEST_METHOD --username=USERNAME
|
||||
--validate-ssl=VALIDATE_SSL --add-status-classes=[status-class,...]
|
||||
| --clear-status-classes=CLEAR_STATUS_CLASSES
|
||||
| --remove-status-classes=[status-class,...]
|
||||
| --set-status-classes=[status-class,...]
|
||||
| --add-status-codes=[status-code,...]
|
||||
| --clear-status-codes=CLEAR_STATUS_CODES
|
||||
| --remove-status-codes=[status-code,...]
|
||||
| --set-status-codes=[status-code,...]
|
||||
--update-headers=[KEY=VALUE,...] --clear-headers=CLEAR_HEADERS
|
||||
| --remove-headers=[KEY,...]]
|
||||
[--display-name=DISPLAY_NAME
|
||||
--period=PERIOD --timeout=TIMEOUT --add-regions=[region,...]
|
||||
| --clear-regions=CLEAR_REGIONS | --remove-regions=[region,...]
|
||||
| --set-regions=[region,...]
|
||||
--update-user-labels=[KEY=VALUE,...] --clear-user-labels
|
||||
| --remove-user-labels=[KEY,...]]
|
||||
[--matcher-content=MATCHER_CONTENT
|
||||
: --matcher-type=MATCHER_TYPE [--json-path=JSON_PATH
|
||||
: --json-path-matcher-type=JSON_PATH_MATCHER_TYPE]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Updates an existing uptime check.
|
||||
|
||||
For information about the JSON/YAML format of an uptime check:
|
||||
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.uptimeCheckConfigs
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Uptime Check resource - Name of the Uptime Check to be updated. This
|
||||
represents a Cloud resource. (NOTE) Some attributes are not given
|
||||
arguments in this group but can be set in other ways.
|
||||
|
||||
To set the project attribute:
|
||||
◆ provide the argument check_id on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
CHECK_ID
|
||||
ID of the Uptime Check or fully qualified identifier for the Uptime
|
||||
Check.
|
||||
|
||||
To set the uptime_check attribute:
|
||||
▸ provide the argument check_id on the command line.
|
||||
|
||||
FLAGS
|
||||
Uptime check protocol settings
|
||||
|
||||
--body=BODY
|
||||
The request body associated with the HTTP POST request. Can only be
|
||||
set if --protocol is "http" or "https".
|
||||
|
||||
--content-type=CONTENT_TYPE
|
||||
The content type header to use for the check, defaults to
|
||||
"unspecified". Can only be set if --protocol is "http" or "https".
|
||||
|
||||
CONTENT_TYPE must be one of:
|
||||
|
||||
unspecified
|
||||
Not specified
|
||||
url-encoded
|
||||
URL encoded
|
||||
user-provided
|
||||
User provided
|
||||
|
||||
--custom-content-type=CUSTOM_CONTENT_TYPE
|
||||
A user-provided content type header to use for the check. Can only be
|
||||
set if --protocol is "http" or "https".
|
||||
|
||||
--mask-headers=MASK_HEADERS
|
||||
Whether to encrypt the header information, defaults to "false". Can
|
||||
only be set if --protocol is "http" or "https".
|
||||
|
||||
--password=PASSWORD
|
||||
The password to use when authenticating with the HTTP server. Can
|
||||
only be set if --protocol is "http" or "https".
|
||||
|
||||
--path=PATH
|
||||
The path to the page against which to run the check, defaults to "/".
|
||||
Can only be set if --protocol is "http" or "https".
|
||||
|
||||
--pings-count=PINGS_COUNT
|
||||
Number of ICMP pings to send alongside the request.
|
||||
|
||||
--port=PORT
|
||||
The port on the server against which to run the check. Defaults to
|
||||
"80" when --protocol is "http". Defaults to "443" when --protocol is
|
||||
"https". Required if --protocol is "tcp".
|
||||
|
||||
--request-method=REQUEST_METHOD
|
||||
The HTTP request method to use, defaults to "get". Can only be set if
|
||||
--protocol is "http" or "https".
|
||||
|
||||
REQUEST_METHOD must be one of:
|
||||
|
||||
get
|
||||
HTTP GET method
|
||||
post
|
||||
HTTP POST method
|
||||
|
||||
--username=USERNAME
|
||||
The username to use when authenticating with the HTTP server. Can
|
||||
only be set if --protocol is "http" or "https".
|
||||
|
||||
--validate-ssl=VALIDATE_SSL
|
||||
Whether to include SSL certificate validation as a part of the Uptime
|
||||
Check, defaults to "false". Can only be set if --protocol is "https".
|
||||
|
||||
Uptime Status
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
Uptime Status Classes
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--add-status-classes=[status-class,...]
|
||||
The list of HTTP Status Classes to add to the Uptime Check.
|
||||
status-class must be one of:
|
||||
|
||||
1xx
|
||||
Any response code from 100-199 inclusive
|
||||
2xx
|
||||
Any response code from 200-299 inclusive
|
||||
3xx
|
||||
Any response code from 300-399 inclusive
|
||||
4xx
|
||||
Any response code from 400-499 inclusive
|
||||
5xx
|
||||
Any response code from 500-599 inclusive
|
||||
any
|
||||
Any response code
|
||||
|
||||
--clear-status-classes=CLEAR_STATUS_CLASSES
|
||||
Clear all HTTP Status Classes on the Uptime Check. This will act
|
||||
the same as if only "2xx" was selected.
|
||||
|
||||
--remove-status-classes=[status-class,...]
|
||||
The list of HTTP Status Classes to remove from the Uptime Check.
|
||||
status-class must be one of:
|
||||
|
||||
1xx
|
||||
Any response code from 100-199 inclusive
|
||||
2xx
|
||||
Any response code from 200-299 inclusive
|
||||
3xx
|
||||
Any response code from 300-399 inclusive
|
||||
4xx
|
||||
Any response code from 400-499 inclusive
|
||||
5xx
|
||||
Any response code from 500-599 inclusive
|
||||
any
|
||||
Any response code
|
||||
|
||||
--set-status-classes=[status-class,...]
|
||||
List of HTTP Status Classes. The Uptime Check will only pass if
|
||||
the response code is contained in this list.
|
||||
|
||||
status-class must be one of:
|
||||
|
||||
1xx
|
||||
Any response code from 100-199 inclusive
|
||||
2xx
|
||||
Any response code from 200-299 inclusive
|
||||
3xx
|
||||
Any response code from 300-399 inclusive
|
||||
4xx
|
||||
Any response code from 400-499 inclusive
|
||||
5xx
|
||||
Any response code from 500-599 inclusive
|
||||
any
|
||||
Any response code
|
||||
|
||||
Uptime Status Codes
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--add-status-codes=[status-code,...]
|
||||
The list of HTTP Status Codes to add to the Uptime Check.
|
||||
|
||||
--clear-status-codes=CLEAR_STATUS_CODES
|
||||
Clear all HTTP Status Codes on the Uptime Check. This will act
|
||||
the same as if only the "2xx" HTTP Status Class was selected.
|
||||
|
||||
--remove-status-codes=[status-code,...]
|
||||
The list of HTTP Status Codes to remove from the Uptime Check.
|
||||
|
||||
--set-status-codes=[status-code,...]
|
||||
List of HTTP Status Codes. The Uptime Check will only pass if the
|
||||
response code is present in this list.
|
||||
|
||||
Uptime Headers
|
||||
|
||||
--update-headers=[KEY=VALUE,...]
|
||||
The list of headers to add to the Uptime Check. Any existing
|
||||
headers with matching "key" will be overridden by the provided
|
||||
values.
|
||||
|
||||
Uptime remove Headers
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--clear-headers=CLEAR_HEADERS
|
||||
Clear all headers on the Uptime Check.
|
||||
|
||||
--remove-headers=[KEY,...]
|
||||
The list of header keys to remove from the Uptime Check.
|
||||
|
||||
Uptime check settings
|
||||
|
||||
--display-name=DISPLAY_NAME
|
||||
The display name for the Uptime Check.
|
||||
|
||||
--period=PERIOD
|
||||
How often, in minutes, the Uptime check is performed, defaults to
|
||||
"1". PERIOD must be one of:
|
||||
|
||||
1
|
||||
One minute
|
||||
10
|
||||
Ten minutes
|
||||
15
|
||||
Fifteen minutes
|
||||
5
|
||||
Five minutes
|
||||
|
||||
--timeout=TIMEOUT
|
||||
The maximum amount of time in seconds to wait for the request to
|
||||
complete, defaults to "60".
|
||||
|
||||
Uptime Selected Regions
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--add-regions=[region,...]
|
||||
The list of regions to add to the Uptime Check. region must be one
|
||||
of:
|
||||
|
||||
asia-pacific
|
||||
asia-southeast1
|
||||
europe
|
||||
europe-west1
|
||||
south-america
|
||||
southamerica-east1
|
||||
usa-iowa
|
||||
us-central1
|
||||
usa-oregon
|
||||
us-west1
|
||||
usa-virginia
|
||||
us-east4
|
||||
|
||||
--clear-regions=CLEAR_REGIONS
|
||||
Clear all regions on the Uptime Check. This will act the same as if
|
||||
all available regions were selected.
|
||||
|
||||
--remove-regions=[region,...]
|
||||
The list of regions to remove from the Uptime Check. region must be
|
||||
one of:
|
||||
|
||||
asia-pacific
|
||||
asia-southeast1
|
||||
europe
|
||||
europe-west1
|
||||
south-america
|
||||
southamerica-east1
|
||||
usa-iowa
|
||||
us-central1
|
||||
usa-oregon
|
||||
us-west1
|
||||
usa-virginia
|
||||
us-east4
|
||||
|
||||
--set-regions=[region,...]
|
||||
The list of regions from which the check will be run. At least 3
|
||||
regions must be selected.
|
||||
|
||||
region must be one of:
|
||||
|
||||
asia-pacific
|
||||
asia-southeast1
|
||||
europe
|
||||
europe-west1
|
||||
south-america
|
||||
southamerica-east1
|
||||
usa-iowa
|
||||
us-central1
|
||||
usa-oregon
|
||||
us-west1
|
||||
usa-virginia
|
||||
us-east4
|
||||
|
||||
uptime check
|
||||
|
||||
--update-user-labels=[KEY=VALUE,...]
|
||||
List of label KEY=VALUE pairs to update. If a label exists, its
|
||||
value is modified. Otherwise, a new label is created.
|
||||
|
||||
Keys must start with a lowercase character and contain only hyphens
|
||||
(-), underscores (_), lowercase characters, and numbers. Values
|
||||
must contain only hyphens (-), underscores (_), lowercase
|
||||
characters, and numbers.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--clear-user-labels
|
||||
Remove all labels. If --update-user-labels is also specified then
|
||||
--clear-user-labels is applied first.
|
||||
|
||||
For example, to remove all labels:
|
||||
|
||||
$ gcloud alpha monitoring uptime update --clear-user-labels
|
||||
|
||||
To remove all existing labels and create two new labels, foo and
|
||||
baz:
|
||||
|
||||
$ gcloud alpha monitoring uptime update --clear-user-labels \
|
||||
--update-user-labels foo=bar,baz=qux
|
||||
|
||||
--remove-user-labels=[KEY,...]
|
||||
List of label keys to remove. If a label does not exist it is
|
||||
silently ignored. If --update-user-labels is also specified then
|
||||
--update-user-labels is applied first.
|
||||
|
||||
Uptime matcher settings
|
||||
|
||||
--matcher-content=MATCHER_CONTENT
|
||||
String, regex or JSON content to match.
|
||||
|
||||
This flag argument must be specified if any of the other arguments in
|
||||
this group are specified.
|
||||
|
||||
--matcher-type=MATCHER_TYPE
|
||||
The type of content matcher that will be applied to the server
|
||||
output, defaults to "contains-string".
|
||||
|
||||
MATCHER_TYPE must be one of:
|
||||
|
||||
contains-string
|
||||
Response contains string
|
||||
matches-json-path
|
||||
Response matches at JSONPath
|
||||
matches-regex
|
||||
Response matches regex
|
||||
not-contains-string
|
||||
Response does not contain string
|
||||
not-matches-json-path
|
||||
Response does not match at JSONPath
|
||||
not-matches-regex
|
||||
Response does not match regex
|
||||
|
||||
Uptime matcher settings for JSON responses
|
||||
|
||||
--json-path=JSON_PATH
|
||||
JSONPath within the response output pointing to the expected
|
||||
content to match. Only used if matcher-type is "matches-json-path"
|
||||
or "not-matches-json-path".
|
||||
|
||||
This flag argument must be specified if any of the other arguments
|
||||
in this group are specified.
|
||||
|
||||
--json-path-matcher-type=JSON_PATH_MATCHER_TYPE
|
||||
The type of JSONPath match that will be applied to the JSON output,
|
||||
defaults to "exact-match". Only used if matcher-type is
|
||||
"matches-json-path" or "not-matches-json-path".
|
||||
|
||||
JSON_PATH_MATCHER_TYPE must be one of:
|
||||
|
||||
exact-match
|
||||
Response matches exact string at JSONPath
|
||||
regex-match
|
||||
Response matches regex at JSONPath
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --access-token-file, --account,
|
||||
--billing-project, --configuration, --flags-file, --flatten, --format,
|
||||
--help, --impersonate-service-account, --log-http, --project, --quiet,
|
||||
--trace-token, --user-output-enabled, --verbosity.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
NOTES
|
||||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue