Gunakan QuerySnapshotJobList untuk mengkueri job snapshot - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Mengkueri pekerjaan snapshot.

Deskripsi operasi

You can query snapshot jobs by specifying one or more snapshot job IDs (SnapshotJobIds). You can also perform a paged query and filter jobs by status, creation time, or MPS queue without specifying job IDs.
This operation queries a maximum of 10 snapshot jobs per call.
The return values of this operation are sorted by CreationTime in descending order by default.

QPS limits

This operation is limited to 100 queries per second (QPS) per user. If you exceed this limit, API calls are throttled, which may affect your business. To prevent throttling, you can call this operation at a reasonable rate. For more information, see QPS limits.

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 Manajemen Tugas > Snapshot. 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 untuk setiap kueri. Gunakan token ini di kueri berikutnya untuk mengambil halaman hasil berikutnya.	cc6cbef8e8d5481ca536f5d2a466****
MaximumPageSize	integer	No	Jumlah maksimum entri yang dikembalikan pada setiap halaman 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 berlangsung. Success: Pekerjaan berhasil. Fail: Pekerjaan gagal.	Snapshoting
StartOfJobCreatedTimeRange	string	No	Awal rentang waktu pembuatan pekerjaan. Format tanggal harus mengikuti standar ISO 8601 dan menggunakan Coordinated Universal Time (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 Coordinated Universal Time (UTC). Formatnya adalah YYYY-MM-DDThh:mm:ssZ.	2014-01-12T12:00:00Z
PipelineId	string	No	ID antrian MPS. Untuk informasi lebih lanjut, lihat Istilah. Anda dapat melihat dan membuat antrian MPS di Konsol MPS dengan memilih Pengaturan Global > Pipeline. Jika Anda ingin menerima pesan notifikasi asinkron, sambungkan antrian atau topik MNS ke antrian MPS. Untuk informasi lebih lanjut, lihat Menerima notifikasi pesan.	b11c171cced04565b1f38f1ecc39****

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
SnapshotJobList	object
SnapshotJob	array<object>	The list of snapshot jobs.
	array<object>	The response parameters.
CreationTime	string	The stride of a single image.	2021-06-30T12:34:29Z
SnapshotConfig	object	The height of a single image. The default value is the height of the output snapshot.
Time	string	The width of a single image. The default value is the width of the output snapshot.	4
TileOut	object	The margin width of the tiled image. Default value: 0. Unit: pixel.
Padding	string	The number of columns that the tiled image can contain. Default value: 10.	0
Color	string	Indicates whether the single images are retained. Default value: true.	black
CellSelStep	string	The number of rows that the tiled image can contain. Default value: 10.	3
CellHeight	string	The interval for taking snapshots. If this Interval parameter is specified in the request, snapshots are taken at intervals. The value must be greater than 0. Unit: seconds. Default value: 10.	8
CellWidth	string	The type of the snapshot. Valid values: normal: normal frames. intra: I-frames. Default value: intra.	8
Margin	string	The width of the output snapshot.	0
Columns	string	The height of the output snapshot.	10
IsKeepCellPic	string	The Object Storage Service (OSS) output file of the snapshot job.	false
Lines	string	The Alibaba Cloud Resource Name (ARN) of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.	10
Interval	string	The OSS object that is generated as the output file of the snapshot job.	10
FrameType	string	The ID of the region in which the output OSS bucket is located.	intra
Width	string	The OSS bucket that stores the output file.	8
Height	string	The number of snapshots to take. If the Num parameter is set in the request, snapshots are taken at intervals.	8
OutputFile	object	The OSS output file of the tiling job.
RoleArn	string	The ARN of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	The OSS object that is generated as the output file of the tiling job.	example.png
Location	string	The ID of the region in which the output OSS bucket is located.	example-location
Bucket	string	The OSS bucket that stores the output file.	example
Num	string	The status of the snapshot job. Submitted: The job was submitted. Snapshoting: The job is being processed. Success: The job was successfully processed. Fail: The job failed.	10
TileOutputFile	object	The error message returned when the job fails. This parameter is not returned if the job is successfully processed.
RoleArn	string	The message sent by MNS to notify the user of the job result.	acs:ram::1:role/testrole
Object	string	The ID of the message. This parameter is not returned if the job fails.	example.png
Location	string	The error message returned when the job fails. This parameter is not returned if the job is successfully processed.	example-location
Bucket	string	The error code returned when the job fails. This parameter is not returned if the job is successfully processed.	example
TimeArray	object
TimePointList	array
	integer		[10050, 50000, 110000, 1000500, 1100500]
State	string	The information about the job input.	Snapshoting
Message	string	The ARN of the specified RAM role. Format: acs:ram::$accountID:role/$roleName.	The resource operated InputFile is bad
MNSMessageResult	object	The OSS object that is used as the input file.
MessageId	string	The ID of the region in which the input OSS bucket is located.	799454621135656C7F815F198A76****
ErrorMessage	string	The OSS bucket that stores the input file.	The resource operated InputFile is bad
ErrorCode	string	The number of snapshots that were taken.	InvalidParameter
Input	object	The number of snapshots that are contained in the tiled image.
RoleArn	string	The custom data.	acs:ram::1:role/testrole
Object	string	The error code returned when the job fails. This parameter is not returned if the job is successfully processed.	example.flv
Location	string	The ID of the MPS queue to which the snapshot job was submitted.	example-location
Bucket	string	The ID of the snapshot job.	example
Count	string	The ID of the request.	1
TileCount	string	The snapshot job IDs that do not exist. This parameter is not returned if all specified snapshot jobs are found.	7
UserData	string	The token that is used to retrieve the next page of the query results. The value is a 32-bit UUID. If the returned query results cannot be displayed within one page, this parameter is returned. The value of this parameter is updated for each query.	testid-001
Code	string	You can call this operation to query up to 10 snapshot jobs at a time. Limits on QPS You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit.	InvalidParameter
PipelineId	string	The start time for taking snapshots. Unit: milliseconds.	b11c171cced04565b1f38f1ecc39****
Id	string	The OSS output file of the tiling job.	cc6cbef8e8d5481ca536f5d2a466****
RequestId	string	The ID of the request.	34BCAB31-2833-43A7-9FBD-B34302AB23EQ
NonExistSnapshotJobIds	object
String	array	The list of non-existent snapshot job IDs.
	string	The details of a non-existent snapshot job ID. This parameter is not returned if no data exists.	c6d973c33d1c4b21bc39907d3b29****
NextPageToken	string	The token for the next page. It is a 32-bit UUID. This parameter is returned when the query result is truncated. The value of this parameter is updated for each query.	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.