ListEnvCustomJobs - Application Real-Time Monitoring Service

Meminta daftar pekerjaan kustom dalam suatu lingkungan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

arms:ListEnvCustomJobs

list

*Environment

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region.	cn-hangzhou
EnvironmentId	string	Yes	ID instance lingkungan.	env-xxxxx
EncryptYaml	boolean	No	Menentukan apakah akan mengembalikan YAML terenkripsi.	true

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan	2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Code	integer	Kode status. Nilai 200 menunjukkan bahwa permintaan berhasil.	200
Data	array<object>	Struktur yang dikembalikan.
	array<object>	Struktur yang dikembalikan.
EnvironmentId	string	ID instance lingkungan.	env-xxxx
RegionId	string	ID region.	cn-hangzhou
CustomJobName	string	Nama pekerjaan kustom.	job1
ConfigYaml	string	Jika parameter permintaan encryptYaml diatur ke true, string YAML yang dikodekan Base64 akan dikembalikan. Jika tidak, string YAML teks biasa akan dikembalikan.	参见补充说明。
Status	string	Status.	run
CreationTimestamp	string	Waktu ketika pekerjaan dibuat (timestamp).	2022-01-01T10:11:34Z
AddonName	string	Nama add-on tempat pekerjaan tersebut berada.	mysql
AddonReleaseName	string	Nama instance add-on tempat pekerjaan tersebut berada.	mysql1
AddonVersion	string	Versi add-on tempat pekerjaan tersebut berada.	1.1.0
ScrapeConfigs	array<object>	Konfigurasi scrape.
	object	Konfigurasi scrape.
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	Pesan yang dikembalikan.	success

Contoh

Respons sukses

JSONformat

{
  "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"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.