Queries the PodMonitors of an environment.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-hangzhou |
| EnvironmentId |
string |
Yes |
The environment ID. |
env-xxxxx |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
4C518054-852F-4023-ABC1-4AF95FF7**** |
| Code |
integer |
The HTTP status code. The status code 200 indicates that the request was successful. |
200 |
| Data |
array<object> |
The result of the operation. |
|
|
array<object> |
The returned struct. |
||
| RegionId |
string |
The region ID. |
cn-beijing |
| EnvironmentId |
string |
The environment ID. |
env-xxxxx |
| Namespace |
string |
The namespace. |
arms-prom |
| PodMonitorName |
string |
The name of the PodMonitor. |
pm1 |
| ConfigYaml |
string |
The YAML configuration string. |
参见补充说明。 |
| Status |
string |
The status of the PodMonitor. |
run |
| CreationTimestamp |
string |
The time when the PodMonitor was created. The value of this parameter is a timestamp. |
2011-01-02T11:34:22Z |
| AddonName |
string |
The name of the add-on to which the PodMonitor belongs. |
mysql |
| AddonReleaseName |
string |
The instance name of the add-on. |
mysql1 |
| AddonVersion |
string |
The version of the add-on. |
1.0.5 |
| Endpoints |
array<object> |
The endpoints of the PodMonitor. |
|
|
object |
Endpoint list. |
||
| Port |
string |
The external port. |
9182 |
| TargetPort |
integer |
The destination port. |
3306 |
| Path |
string |
The collection path. |
/metrics |
| Interval |
string |
The collection interval. |
30s |
| MatchedTargetCount |
integer |
The number of pods that match the PodMonitor endpoint. |
1 |
| Message |
string |
The returned message. |
success |
Examples
Success response
JSON format
{
"RequestId": "4C518054-852F-4023-ABC1-4AF95FF7****",
"Code": 200,
"Data": [
{
"RegionId": "cn-beijing",
"EnvironmentId": "env-xxxxx",
"Namespace": "arms-prom",
"PodMonitorName": "pm1",
"ConfigYaml": "参见补充说明。",
"Status": "run",
"CreationTimestamp": "2011-01-02T11:34:22Z",
"AddonName": "mysql",
"AddonReleaseName": "mysql1",
"AddonVersion": "1.0.5",
"Endpoints": [
{
"Port": "9182",
"TargetPort": 3306,
"Path": "/metrics",
"Interval": "30s",
"MatchedTargetCount": 1
}
]
}
],
"Message": "success"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.