Method: projects.locations.caPools.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://privateca.googleapis.com/v1/{parent=projects/*/locations/*}/caPools
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The resource name of the location associated with the CaPools, in the format projects/*/locations/*.
Authorization requires the following IAM permission on the specified resource parent:
|
Query parameters
| Parameters |
pageSize |
integer
Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
|
pageToken |
string
Optional. Pagination token, returned earlier via ListCaPoolsResponse.next_page_token.
|
filter |
string
Optional. Only include resources that match the filter in the response.
|
orderBy |
string
Optional. Specify how the results should be sorted.
|
Request body
The request body must be empty.
Response body
Response message for CertificateAuthorityService.ListCaPools.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"caPools": [
{
object (CaPool)
}
],
"nextPageToken": string,
"unreachable": [
string
]
} |
| Fields |
caPools[] |
object (CaPool)
The list of CaPools.
|
nextPageToken |
string
A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.page_token to retrieve the next page of results.
|
unreachable[] |
string
A list of locations (e.g. "us-west1") that could not be reached.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-06 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-06 UTC."],[[["This page details how to list Certificate Authority (CA) Pools using a GET request to the specified URL, `https://privateca.googleapis.com/v1/{parent=projects/*/locations/*}/caPools`."],["The `parent` path parameter is required and must be a string representing the location associated with the CA Pools, formatted as `projects/*/locations/*`, requiring `privateca.caPools.list` IAM permission."],["Optional query parameters like `pageSize`, `pageToken`, `filter`, and `orderBy` allow for customizing the list results by limiting the number of CA Pools, paginating results, and filtering or sorting the data."],["The response to a successful request is in JSON format, and will include a list of `caPools`, a `nextPageToken` for further pagination, and an `unreachable` list of locations that couldn't be reached."],["The OAuth scope `https://www.googleapis.com/auth/cloud-platform` is required for authorization."]]],[]]
