- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- Try it!
Lists metric descriptors that match a filter. This method does not require a Workspace.
HTTP request
GET https://monitoring.googleapis.com/v3/{name}/metricDescriptors
Path parameters
Parameters | |
---|---|
name |
Required. The project on which to execute the request. The format is:
|
Query parameters
Parameters | |
---|---|
filter |
If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:
|
pageSize |
A positive number that is the maximum number of results to return. |
pageToken |
If this field is not empty then it must contain the |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
The metricDescriptors.list
response.
JSON representation | |
---|---|
{
"metricDescriptors": [
{
object ( |
Fields | |
---|---|
metricDescriptors[] |
The metric descriptors that are available to the project and that match the value of |
nextPageToken |
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/monitoring
https://www.googleapis.com/auth/monitoring.read
https://www.googleapis.com/auth/monitoring.write
For more information, see the Authentication Overview.