DescribeEnvCustomJob - Application Real-Time Monitoring Service

Queries the details of a custom job for 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:DescribeEnvCustomJob	get	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-xxxxxx
CustomJobName	string	Yes	The name of the custom job.	customJob1
EncryptYaml	boolean	No	Specifies whether to return an encrypted YAML string.	true

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
RequestId	string	The request ID.	6A9AEA84-7186-4D8D-B498-4585C6A2****
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-xxxxx
RegionId	string	The region ID.	cn-hangzhou
CustomJobName	string	The name of the custom job.	customJob1
ConfigYaml	string	If the encryptYaml parameter 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. Valid values: run stop	run
Message	string	The returned message.	success

Sample ConfigYaml:

scrape_configs:
- job_name: job-demo1
  honor_timestamps: false
  honor_labels: false
  scrape_interval: 30s
  scheme: http
  metrics_path: /metric
  static_configs:
  - targets:
    - 127.0.0.1:9090
- job_name: job-demo2
  honor_timestamps: false
  honor_labels: false
  scrape_interval: 30s
  scheme: http
  metrics_path: /metric
  static_configs:
  - targets:
    - 127.0.0.1:9090
  http_sd_configs:
  - url: 127.0.0.1:9090
    refresh_interval: 30s

Examples

Sample success responses

JSONformat

{
  "RequestId": "6A9AEA84-7186-4D8D-B498-4585C6A2****",
  "Code": 200,
  "Data": {
    "EnvironmentId": "env-xxxxx",
    "RegionId": "cn-hangzhou",
    "CustomJobName": "customJob1",
    "ConfigYaml": "Refer to supplementary instructions.",
    "Status": "run"
  },
  "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