ListEnvPodMonitors - Application Real-Time Monitoring Service

Queries the PodMonitors of an environment.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:ListEnvPodMonitors	list	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
EnvironmentId	string	Yes	The environment ID.	env-xxxxx

Response parameters

Parameter	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.
Monitoring	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.	Refer to supplementary instructions.
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.
Endpoint	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

Sample success responses

JSONformat

{
  "RequestId": "4C518054-852F-4023-ABC1-4AF95FF7****",
  "Code": 200,
  "Data": [
    {
      "RegionId": "cn-beijing",
      "EnvironmentId": "env-xxxxx",
      "Namespace": "arms-prom",
      "PodMonitorName": "pm1",
      "ConfigYaml": "Refer to supplementary instructions.",
      "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history