QuerySnapshotJobList - ApsaraVideo Media Processing: Central de Documentação do Alibaba Cloud

Consulta trabalhos de snapshot.

Descrição da operação

Você pode consultar trabalhos de snapshot especificando um ou mais IDs de trabalho de snapshot (SnapshotJobIds). Você também pode realizar uma consulta paginada e filtrar trabalhos por status, hora de criação ou fila do MPS sem especificar os IDs dos trabalhos.
Esta operação consulta no máximo 10 trabalhos de snapshot por chamada.
Os valores de retorno desta operação são classificados por CreationTime em ordem decrescente por padrão.

Limites de QPS

Esta operação é limitada a 100 consultas por segundo (QPS) por usuário. Se você exceder esse limite, as chamadas de API serão limitadas, o que pode afetar seus negócios. Para evitar a limitação, você pode chamar esta operação a uma taxa razoável. Para mais informações, consulte Limites de QPS.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

mts:QuerySnapshotJobList

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SnapshotJobIds	string	Não	A lista de IDs de trabalhos de snapshot. Você pode consultar até 10 trabalhos por vez. Separe vários IDs com vírgulas (,). Você pode obter os IDs dos trabalhos no console do MPS escolhendo Gerenciamento de tarefas > Snapshots. Você também pode obtê-los a partir dos parâmetros de resposta da operação SubmitSnapshotJob.	72dfa5e679ab4be9a3ed9974c736****
NextPageToken	string	Não	O token para a próxima página. É um identificador universalmente exclusivo (UUID) de 32 bits. Se o resultado da consulta for truncado, o parâmetro NextPageToken será retornado. O valor deste parâmetro é atualizado a cada consulta. Use este token na próxima consulta para recuperar a próxima página de resultados.	cc6cbef8e8d5481ca536f5d2a466****
MaximumPageSize	integer	Não	O número máximo de entradas a serem retornadas em cada página de uma consulta paginada. Valores válidos: [1, 300]. Valor padrão: 30.	30
State	string	Não	O estado dos trabalhos de snapshot a serem consultados. Submitted: O trabalho foi enviado. Snapshoting: O trabalho está em andamento. Success: O trabalho foi bem-sucedido. Fail: O trabalho falhou.	Snapshoting
StartOfJobCreatedTimeRange	string	Não	O início do intervalo de tempo de criação do trabalho. O formato da data deve seguir o padrão ISO 8601 e usar o Tempo Universal Coordenado (UTC). O formato é YYYY-MM-DDThh:mm:ssZ.	2014-01-10T12:00:00Z
EndOfJobCreatedTimeRange	string	Não	O fim do intervalo de tempo de criação do trabalho. O formato da data deve seguir o padrão ISO 8601 e usar o Tempo Universal Coordenado (UTC). O formato é YYYY-MM-DDThh:mm:ssZ.	2014-01-12T12:00:00Z
PipelineId	string	Não	O ID da fila do MPS. Para mais informações, consulte Termos. Você pode visualizar e criar filas do MPS no console do MPS escolhendo Configurações globais > Pipelines. Se você deseja receber mensagens de notificação assíncronas, anexe uma fila ou tópico do MNS à fila do MPS. Para mais informações, consulte Receber notificações de mensagens.	b11c171cced04565b1f38f1ecc39****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
SnapshotJobList	object
SnapshotJob	array<object>	A lista de trabalhos de snapshot.
	array<object>	Os parâmetros de resposta.
CreationTime	string	The time the job was created.	2021-06-30T12:34:29Z
SnapshotConfig	object	The snapshot configuration.
Time	string	The start time for the snapshot. Unit: milliseconds.	4
TileOut	object	The mosaic configuration.
Padding	string	The spacing between images. Default: 0. Unit: px.	0
Color	string	The background color. Default: black. Valid values: color keyword, random. Nota Color keywords support three formats. For example, black can be specified as Black, black, or #000000.	black
CellSelStep	string	The step size for selecting a single image.	3
CellHeight	string	The height of a single image. The default is the height of the snapshot output.	8
CellWidth	string	The width of a single image. The default is the width of the snapshot output.	8
Margin	string	The width of the outer border. Default: 0. Unit: px.	0
Columns	string	The number of columns in the mosaic. Default: 10.	10
IsKeepCellPic	string	Indicates whether to keep the individual images. Default: true.	false
Lines	string	The number of rows in the mosaic. Default: 10.	10
Interval	string	The snapshot interval. If specified, it indicates a sequence of snapshots, and the value must be greater than 0. Unit: seconds. Default value: 10.	10
FrameType	string	The snapshot type. normal: Normal frame. intra: I-frame. Default value: intra.	intra
Width	string	The width of the output snapshot image.	8
Height	string	The height of the output snapshot image.	8
OutputFile	object	The OSS configuration for the snapshot output.
RoleArn	string	The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	The output file (OSS Object) for the snapshot.	example.png
Location	string	The data center where the output OSS bucket is located (OSS Location).	example-location
Bucket	string	The OSS bucket where the output file is stored.	example
Num	string	The number of snapshots. If specified, it indicates a sequence of snapshots.	10
TileOutputFile	object	The OSS configuration for the large image output of the mosaic job.
RoleArn	string	The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	The output file (OSS Object).	example.png
Location	string	The data center where the output OSS bucket is located (OSS Location).	example-location
Bucket	string	The OSS bucket where the output file is stored.	example
TimeArray	object
TimePointList	array	The array of specified time points.
	integer	The array of specified time points. Unit: milliseconds. This is a floating-point number with two decimal places. The time points can be repeated and submitted in any order. MPS sorts them. A maximum of 100 time points are supported. If you specify this parameter, do not specify Num, Time, or Interval. Otherwise, an InvalidParameter.Ambiguity error is returned.	[10050, 50000, 110000, 1000500, 1100500]
State	string	The state of the snapshot job. Submitted: The job is submitted. Snapshoting: The job is in progress. Success: The job is successful. Fail: The job failed.	Snapshoting
Message	string	The error message returned when the analysis fails. This parameter is not returned if the job is successful.	The resource operated InputFile is bad
MNSMessageResult	object	The result of the MNS notification sent to the user when the job is complete.
MessageId	string	The ID of the message. This parameter is not returned if the job fails.	799454621135656C7F815F198A76****
ErrorMessage	string	The error message. This parameter is not returned if the job is successful.	The resource operated InputFile is bad
ErrorCode	string	The error code. This parameter is not returned if the job is successful.	InvalidParameter
Input	object	The job input.
RoleArn	string	The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	The input file (OSS Object).	example.flv
Location	string	The data center where the input OSS bucket is located (OSS Location).	example-location
Bucket	string	The OSS bucket where the input file is stored.	example
Count	string	The number of captured images.	1
TileCount	string	The number of images in the mosaic.	7
UserData	string	The user-defined data.	testid-001
Code	string	The error code returned when the analysis fails. This parameter is not returned if the job is successful.	InvalidParameter
PipelineId	string	The pipeline ID.	b11c171cced04565b1f38f1ecc39****
Id	string	The ID of the snapshot job.	cc6cbef8e8d5481ca536f5d2a466****
RequestId	string	O ID da solicitação.	34BCAB31-2833-43A7-9FBD-B34302AB23EQ
NonExistSnapshotJobIds	object
String	array	A lista de IDs de trabalhos de snapshot inexistentes.
	string	Os detalhes de um ID de trabalho de snapshot inexistente. Este parâmetro não é retornado se não houver dados.	c6d973c33d1c4b21bc39907d3b29****
NextPageToken	string	O token para a próxima página. É um UUID de 32 bits. Este parâmetro é retornado quando o resultado da consulta é truncado. O valor deste parâmetro é atualizado a cada consulta.	b11c171cced04565b1f38f1ecc39****

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.