redis.projects.locations.instances.list
GET {{baseUrl}}/v1/:parent/instances?pageSize=<integer>&pageToken=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | string | The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. | |
pageToken | string | The next_page_token value returned from a previous ListInstances request, if any. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"instances":[{"alternativeLocationId":"\u003cstring\u003e","authorizedNetwork":"\u003cstring\u003e","connectMode":"\u003cstring\u003e","createTime":"Lorem ullamco adipisicing","currentLocationId":"in","displayName":"\u003cstring\u003e","host":"ipsum aliquip reprehenderit ex","labels":"\u003cobject\u003e","locationId":"\u003cstring\u003e","memorySizeGb":"\u003cinteger\u003e","name":"\u003cstring\u003e","persistenceIamIdentity":"dolor in","port":-64660361,"redisConfigs":"\u003cobject\u003e","redisVersion":"\u003cstring\u003e","reservedIpRange":"\u003cstring\u003e","state":"DELETING","statusMessage":"ad minim mollit sed velit","tier":"\u003cstring\u003e"},{"alternativeLocationId":"\u003cstring\u003e","authorizedNetwork":"\u003cstring\u003e","connectMode":"\u003cstring\u003e","createTime":"reprehenderit qui","currentLocationId":"ea culpa","displayName":"\u003cstring\u003e","host":"est","labels":"\u003cobject\u003e","locationId":"\u003cstring\u003e","memorySizeGb":"\u003cinteger\u003e","name":"\u003cstring\u003e","persistenceIamIdentity":"in","port":-52833225,"redisConfigs":"\u003cobject\u003e","redisVersion":"\u003cstring\u003e","reservedIpRange":"\u003cstring\u003e","state":"UPDATING","statusMessage":"officia enim","tier":"\u003cstring\u003e"}],"nextPageToken":"non tempor do","unreachable":["amet","aliqua Duis est adipisicing"]}