ListEnvCustomJobs - Managed Service for Prometheus - Alibaba Cloud Documentation Center

Queries the custom jobs of an environment.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListEnvCustomJobs	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 ID of the environment instance.	env-xxxxx
EncryptYaml	boolean	No	Specifies whether to return the encrypted YAML string.	true

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Code	integer	The HTTP status code. The status code 200 indicates that the request was successful.	200
Data	object []	The returned struct.
EnvironmentId	string	The ID of the environment instance.	env-xxxx
RegionId	string	The region ID.	cn-hangzhou
CustomJobName	string	The name of the custom job.	job1
ConfigYaml	string	If the request parameter EncryptYaml is set to true, a Base64-encoded YAML string is returned. Otherwise, a plaintext YAML string is returned.	Refer to supplementary instructions.
Status	string	The status of the custom job.	run
CreationTimestamp	string	The time when the custom job was created. The value of this parameter is a timestamp.	2022-01-01T10:11:34Z
AddonName	string	The name of the component to which the custom job belongs.	mysql
AddonReleaseName	string	The instance name of the component.	mysql1
AddonVersion	string	The version of the component.	1.1.0
ScrapeConfigs	object []	The capture configurations.
JobName	string	The name of the job.	custom-sd-demo
ScrapeInterval	string	The capture interval.	30s
MetricsPath	string	The path of the metric.	/metrics
ScrapeDiscoverys	array	The service discovery methods.
	string	The service discovery method.	static_configs
Message	string	The returned message.	success

Examples

Sample success responses

JSONformat

{
  "RequestId": "2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "Code": 200,
  "Data": [
    {
      "EnvironmentId": "env-xxxx",
      "RegionId": "cn-hangzhou",
      "CustomJobName": "job1",
      "ConfigYaml": "Refer to supplementary instructions.",
      "Status": "run",
      "CreationTimestamp": "2022-01-01T10:11:34Z",
      "AddonName": "mysql",
      "AddonReleaseName": "mysql1",
      "AddonVersion": "1.1.0",
      "ScrapeConfigs": [
        {
          "JobName": "custom-sd-demo",
          "ScrapeInterval": "30s",
          "MetricsPath": "/metrics",
          "ScrapeDiscoverys": [
            "static_configs"
          ]
        }
      ]
    }
  ],
  "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