ListEnvCustomJobs-阿里云帮助中心

Queries the custom jobs of an environment.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

arms:ListEnvCustomJobs

list

*Environment

acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

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 elements

Element	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	array<object>	The returned struct.
	array<object>	The data returned.
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.	参见补充说明。
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 add-on to which the custom job belongs.	mysql
AddonReleaseName	string	The instance name of the add-on.	mysql1
AddonVersion	string	The version of the add-on.	1.1.0
ScrapeConfigs	array<object>	The capture configurations.
	object	scrape config
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

Success response

JSON format

{
  "RequestId": "2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "Code": 200,
  "Data": [
    {
      "EnvironmentId": "env-xxxx",
      "RegionId": "cn-hangzhou",
      "CustomJobName": "job1",
      "ConfigYaml": "参见补充说明。",
      "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.