QuerySnapshotJobList -

Kueri pekerjaan snapshot.

Deskripsi operasi

Anda dapat mengkueri pekerjaan snapshot dengan menentukan satu atau beberapa ID pekerjaan snapshot (SnapshotJobIds). Anda juga dapat melakukan kueri berhalaman serta memfilter pekerjaan berdasarkan status, waktu pembuatan, atau antrian MPS tanpa menentukan ID pekerjaan.
Operasi ini mengkueri maksimal 10 pekerjaan snapshot per panggilan.
Nilai kembali operasi ini diurutkan berdasarkan CreationTime secara menurun (descending) secara default.

Batas QPS

Operasi ini dibatasi hingga 100 kueri per detik (QPS) per pengguna. Jika batas ini terlampaui, panggilan API akan mengalami pembatasan kecepatan (throttling), yang dapat memengaruhi bisnis Anda. Untuk mencegah throttling, lakukan pemanggilan operasi ini dengan laju yang wajar. Untuk informasi selengkapnya, lihat Batas QPS.

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

mts:QuerySnapshotJobList

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SnapshotJobIds	string	No	Daftar ID pekerjaan snapshot. Anda dapat mengkueri hingga 10 pekerjaan sekaligus. Pisahkan beberapa ID dengan koma (,). Anda dapat memperoleh ID pekerjaan dari Konsol MPS dengan memilih Task Management > Snapshots. Anda juga dapat memperolehnya dari parameter respons operasi SubmitSnapshotJob.	72dfa5e679ab4be9a3ed9974c736****
NextPageToken	string	No	Token untuk halaman berikutnya. Ini adalah pengidentifikasi unik universal (UUID) 32-bit. Jika hasil kueri terpotong, parameter NextPageToken akan dikembalikan. Nilai parameter ini diperbarui setiap kali kueri dilakukan. Gunakan token ini pada kueri berikutnya untuk mengambil halaman hasil berikutnya.	cc6cbef8e8d5481ca536f5d2a466****
MaximumPageSize	integer	No	Jumlah maksimum entri yang dikembalikan pada setiap halaman dalam kueri berhalaman. Nilai valid: [1, 300]. Nilai default: 30.	30
State	string	No	Status pekerjaan snapshot yang akan dikueri. Submitted: Pekerjaan telah dikirim. Snapshoting: Pekerjaan sedang berjalan. Success: Pekerjaan berhasil. Fail: Pekerjaan gagal.	Snapshoting
StartOfJobCreatedTimeRange	string	No	Awal rentang waktu pembuatan pekerjaan. Format tanggal harus mengikuti standar ISO 8601 dan menggunakan Waktu Universal Terkoordinasi (UTC). Formatnya adalah YYYY-MM-DDThh:mm:ssZ.	2014-01-10T12:00:00Z
EndOfJobCreatedTimeRange	string	No	Akhir rentang waktu pembuatan pekerjaan. Format tanggal harus mengikuti standar ISO 8601 dan menggunakan Waktu Universal Terkoordinasi (UTC). Formatnya adalah YYYY-MM-DDThh:mm:ssZ.	2014-01-12T12:00:00Z
PipelineId	string	No	ID Antrian MPS. Untuk informasi selengkapnya, lihat Terms. Anda dapat melihat dan membuat Antrian MPS di Konsol MPS dengan memilih Global Settings > Pipelines. Jika Anda ingin menerima pesan notifikasi asinkron, sambungkan Antrian MNS atau Topik ke Antrian MPS. Untuk informasi selengkapnya, lihat Receive message notifications.	b11c171cced04565b1f38f1ecc39****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
SnapshotJobList	object
SnapshotJob	array<object>	Daftar pekerjaan snapshot.
	array<object>	Parameter respons.
CreationTime	string	Waktu pekerjaan dibuat.	2021-06-30T12:34:29Z
SnapshotConfig	object	Konfigurasi snapshot.
Time	string	Waktu mulai untuk snapshot. Satuan: milidetik.	4
TileOut	object	Konfigurasi mosaik.
Padding	string	Jarak antar gambar. Default: 0. Satuan: px.	0
Color	string	Warna latar belakang. Default: black. Nilai valid: color keyword, random. Catatan Kata kunci warna mendukung tiga format. Misalnya, black dapat ditentukan sebagai Black, black, atau #000000.	black
CellSelStep	string	Ukuran langkah untuk memilih satu gambar.	3
CellHeight	string	Tinggi satu gambar. Default-nya adalah tinggi output snapshot.	8
CellWidth	string	Lebar satu gambar. Default-nya adalah lebar output snapshot.	8
Margin	string	Lebar batas luar. Default: 0. Satuan: px.	0
Columns	string	Jumlah kolom dalam mosaik. Default: 10.	10
IsKeepCellPic	string	Menunjukkan apakah gambar individual disimpan. Default: true.	false
Lines	string	Jumlah baris dalam mosaik. Default: 10.	10
Interval	string	Interval snapshot. Jika ditentukan, ini menunjukkan urutan snapshot, dan nilainya harus lebih besar dari 0. Satuan: detik. Nilai default: 10.	10
FrameType	string	Jenis snapshot. normal: Frame normal. intra: Frame-I. Nilai default: intra.	intra
Width	string	Lebar gambar output snapshot.	8
Height	string	Tinggi gambar output snapshot.	8
OutputFile	object	Konfigurasi OSS untuk output snapshot.
RoleArn	string	ARN role yang ditentukan. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	File output (OSS Object) untuk snapshot.	example.png
Location	string	Pusat data tempat Bucket OSS output berada (Lokasi OSS).	example-location
Bucket	string	Bucket OSS tempat file output disimpan.	example
Num	string	Jumlah snapshot. Jika ditentukan, ini menunjukkan urutan snapshot.	10
TileOutputFile	object	Konfigurasi OSS untuk output gambar besar dari pekerjaan mosaik.
RoleArn	string	ARN role yang ditentukan. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	File output (OSS Object).	example.png
Location	string	Pusat data tempat Bucket OSS output berada (Lokasi OSS).	example-location
Bucket	string	Bucket OSS tempat file output disimpan.	example
TimeArray	object
TimePointList	array	Array titik waktu yang ditentukan.
	integer	Array titik waktu yang ditentukan. Satuan: milidetik. Ini adalah bilangan titik mengambang dengan dua tempat desimal. Titik waktu dapat diulang dan dikirimkan dalam urutan apa pun. MPS akan mengurutkannya. Maksimal 100 titik waktu didukung. Jika Anda menentukan parameter ini, jangan tentukan Num, Time, atau Interval. Jika tidak, kesalahan InvalidParameter.Ambiguity akan dikembalikan.	[10050, 50000, 110000, 1000500, 1100500]
State	string	Status pekerjaan snapshot. Submitted: Pekerjaan telah dikirim. Snapshoting: Pekerjaan sedang berjalan. Success: Pekerjaan berhasil. Fail: Pekerjaan gagal.	Snapshoting
Message	string	Pesan kesalahan yang dikembalikan saat analisis gagal. Parameter ini tidak dikembalikan jika pekerjaan berhasil.	The resource operated InputFile is bad
MNSMessageResult	object	Hasil Notifikasi MNS yang dikirim ke pengguna saat pekerjaan selesai.
MessageId	string	ID pesan. Parameter ini tidak dikembalikan jika pekerjaan gagal.	799454621135656C7F815F198A76****
ErrorMessage	string	Pesan kesalahan. Parameter ini tidak dikembalikan jika pekerjaan berhasil.	The resource operated InputFile is bad
ErrorCode	string	Kode kesalahan. Parameter ini tidak dikembalikan jika pekerjaan berhasil.	InvalidParameter
Input	object	Input pekerjaan.
RoleArn	string	ARN role yang ditentukan. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	File input (OSS Object).	example.flv
Location	string	Pusat data tempat Bucket OSS input berada (Lokasi OSS).	example-location
Bucket	string	Bucket OSS tempat file input disimpan.	example
Count	string	Jumlah gambar yang diambil.	1
TileCount	string	Jumlah gambar dalam mosaik.	7
UserData	string	Data yang ditentukan pengguna.	testid-001
Code	string	Kode kesalahan yang dikembalikan saat analisis gagal. Parameter ini tidak dikembalikan jika pekerjaan berhasil.	InvalidParameter
PipelineId	string	ID pipeline.	b11c171cced04565b1f38f1ecc39****
Id	string	ID pekerjaan snapshot.	cc6cbef8e8d5481ca536f5d2a466****
RequestId	string	ID permintaan.	34BCAB31-2833-43A7-9FBD-B34302AB23EQ
NonExistSnapshotJobIds	object
String	array	Daftar ID pekerjaan snapshot yang tidak ada.
	string	Detail ID pekerjaan snapshot yang tidak ada. Parameter ini tidak dikembalikan jika tidak ada data.	c6d973c33d1c4b21bc39907d3b29****
NextPageToken	string	Token untuk halaman berikutnya. Ini adalah UUID 32-bit. Parameter ini dikembalikan ketika hasil kueri terpotong. Nilai parameter ini diperbarui setiap kali kueri dilakukan.	b11c171cced04565b1f38f1ecc39****

Contoh

Respons sukses

JSONformat

{
  "SnapshotJobList": {
    "SnapshotJob": [
      {
        "CreationTime": "2021-06-30T12:34:29Z",
        "SnapshotConfig": {
          "Time": "4",
          "TileOut": {
            "Padding": "0",
            "Color": "black",
            "CellSelStep": "3",
            "CellHeight": "8",
            "CellWidth": "8",
            "Margin": "0",
            "Columns": "10",
            "IsKeepCellPic": "false",
            "Lines": "10"
          },
          "Interval": "10",
          "FrameType": "intra",
          "Width": "8",
          "Height": "8",
          "OutputFile": {
            "RoleArn": "acs:ram::1:role/testrole",
            "Object": "example.png",
            "Location": "example-location",
            "Bucket": "example"
          },
          "Num": "10",
          "TileOutputFile": {
            "RoleArn": "acs:ram::1:role/testrole",
            "Object": "example.png",
            "Location": "example-location",
            "Bucket": "example"
          },
          "TimeArray": {
            "TimePointList": [
              0
            ]
          }
        },
        "State": "Snapshoting",
        "Message": "The resource operated InputFile is bad",
        "MNSMessageResult": {
          "MessageId": "799454621135656C7F815F198A76****",
          "ErrorMessage": "The resource operated InputFile is bad",
          "ErrorCode": "InvalidParameter"
        },
        "Input": {
          "RoleArn": "acs:ram::1:role/testrole",
          "Object": "example.flv",
          "Location": "example-location",
          "Bucket": "example"
        },
        "Count": "1",
        "TileCount": "7",
        "UserData": "testid-001",
        "Code": "InvalidParameter",
        "PipelineId": "b11c171cced04565b1f38f1ecc39****",
        "Id": "cc6cbef8e8d5481ca536f5d2a466****"
      }
    ]
  },
  "RequestId": "34BCAB31-2833-43A7-9FBD-B34302AB23EQ",
  "NonExistSnapshotJobIds": {
    "String": [
      "c6d973c33d1c4b21bc39907d3b29****"
    ]
  },
  "NextPageToken": "b11c171cced04565b1f38f1ecc39****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.