Consulta trabalhos de snapshot.
Descrição da operação
Você pode especificar vários IDs de trabalhos de snapshot (SnapshotJobIds) para consulta. Alternativamente, você pode realizar uma consulta paginada sem especificar IDs de trabalhos de snapshot, filtrando por condições como status do snapshot, hora de criação e fila do MPS.
Você pode consultar até 10 trabalhos de snapshot em uma única chamada.
Por padrão, os resultados retornados são classificados em ordem decrescente de CreationTime.
Limites de QPS
O limite de QPS por usuário para esta operação é de 100 chamadas por segundo. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus serviços. Chame a operação adequadamente. Para mais informações, consulte Limites de QPS.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
mts:QuerySnapshotJobList |
list |
*Todos os recursos.
|
Nenhuma | 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.
|
72dfa5e679ab4be9a3ed9974c736**** |
| NextPageToken |
string |
Não |
O token para a próxima página, que é um UUID de 32 caracteres.
|
cc6cbef8e8d5481ca536f5d2a466**** |
| MaximumPageSize |
integer |
Não |
O número máximo de entradas a serem retornadas em cada página em uma consulta paginada.
|
30 |
| State |
string |
Não |
O status do snapshot a ser consultado. Valores válidos:
|
Snapshoting |
| StartOfJobCreatedTimeRange |
string |
Não |
A hora mais antiga em que o trabalho foi criado.
|
2014-01-10T12:00:00Z |
| EndOfJobCreatedTimeRange |
string |
Não |
A hora mais recente em que o trabalho foi criado.
|
2014-01-12T12:00:00Z |
| PipelineId |
string |
Não |
O ID da fila do MPS. Para mais informações, consulte Termos.
|
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 |
A hora em que o trabalho foi criado. A hora é exibida em UTC e formatada de acordo com o padrão ISO 8601 no formato YYYY-MM-DDTHH:mm:ssZ. |
2021-06-30T12:34:29Z |
| SnapshotConfig |
object |
As configurações de snapshot. |
|
| Time |
string |
A hora de início do snapshot. Unidade: milissegundos. |
4 |
| TileOut |
object |
As configurações de sprite de imagem. |
|
| Padding |
string |
O espaçamento entre as imagens.
|
0 |
| Color |
string |
A cor de fundo.
Nota
As palavras-chave de cor suportam três formatos. Por exemplo, preto pode ser representado como Black, black ou #000000. |
black |
| CellSelStep |
string |
O tamanho do passo para selecionar uma única imagem. |
3 |
| CellHeight |
string |
A altura de uma única imagem. Valor padrão: a altura da resolução de saída do snapshot. |
8 |
| CellWidth |
string |
A largura de uma única imagem. Valor padrão: a largura da resolução de saída do snapshot. |
8 |
| Margin |
string |
A largura da moldura externa.
|
0 |
| Columns |
string |
O número de colunas no sprite de imagem. Valor padrão: 10. |
10 |
| IsKeepCellPic |
string |
Especifica se as imagens individuais devem ser mantidas. Valor padrão: true. |
false |
| Lines |
string |
O número de linhas no sprite de imagem. Valor padrão: 10. |
10 |
| Interval |
string |
O intervalo de tempo entre os snapshots.
|
10 |
| FrameType |
string |
O tipo de snapshot. Valores válidos:
|
intra |
| Width |
string |
A largura da imagem de snapshot de saída. |
8 |
| Height |
string |
A altura da imagem de snapshot de saída. |
8 |
| OutputFile |
object |
As configurações do OSS para a saída do snapshot. |
|
| RoleArn |
string |
O ARN da função especificada. Formato: acs:ram::$accountID:role/$roleName. |
acs:ram::1:role/testrole |
| Object |
string |
O arquivo de saída do snapshot (objeto do OSS). |
example.png |
| Location |
string |
O data center onde reside o bucket do OSS para a saída do snapshot (localização do OSS). |
example-location |
| Bucket |
string |
O bucket do OSS onde o arquivo de saída do snapshot é armazenado. |
example |
| Num |
string |
O número de snapshots. Se este parâmetro for especificado, snapshots sequenciais serão capturados. |
10 |
| TileOutputFile |
object |
As configurações do OSS para o sprite de imagem de saída. |
|
| RoleArn |
string |
O ARN da função especificada. Formato: acs:ram::$accountID:role/$roleName. |
acs:ram::1:role/testrole |
| Object |
string |
O arquivo de saída (objeto do OSS). |
example.png |
| Location |
string |
O data center onde reside o bucket do OSS de saída (localização do OSS). |
example-location |
| Bucket |
string |
O bucket do OSS onde o arquivo de saída é armazenado. |
example |
| TimeArray |
object |
||
| TimePointList |
array |
A matriz de pontos de tempo especificados. |
|
|
integer |
A matriz de pontos de tempo especificados. Unidade: milissegundos. Os valores são números de ponto flutuante com duas casas decimais. Os valores podem ser duplicados e enviados fora de ordem, e são classificados pelo MPS. Você pode especificar até 100 pontos de tempo. Se este parâmetro for especificado, não especifique Num, Time ou Interval. Caso contrário, o erro InvalidParameter.Ambiguity será relatado. |
[10050, 50000, 110000, 1000500, 1100500] |
|
| State |
string |
O status do snapshot. Valores válidos:
|
Snapshoting |
| Message |
string |
A mensagem de erro retornada quando o snapshot falha. Este parâmetro não é retornado se o trabalho for bem-sucedido. |
The resource operated InputFile is bad |
| MNSMessageResult |
object |
O resultado da notificação do MNS enviada ao usuário após a conclusão do trabalho. |
|
| MessageId |
string |
O ID da mensagem retornado quando a notificação é bem-sucedida. Este parâmetro não é retornado se a notificação falhar. |
799454621135656C7F815F198A76**** |
| ErrorMessage |
string |
A mensagem de erro retornada quando a notificação falha. Este parâmetro não é retornado se a notificação for bem-sucedida. |
The resource operated InputFile is bad |
| ErrorCode |
string |
O código de erro retornado quando a notificação falha. Este parâmetro não é retornado se a notificação for bem-sucedida. |
InvalidParameter |
| Input |
object |
A entrada do trabalho. |
|
| RoleArn |
string |
O ARN da função especificada. Formato: acs:ram::$accountID:role/$roleName. |
acs:ram::1:role/testrole |
| Object |
string |
O arquivo de entrada (objeto do OSS). |
example.flv |
| Location |
string |
O data center onde reside o bucket do OSS de entrada (localização do OSS). |
example-location |
| Bucket |
string |
O bucket do OSS onde o arquivo de entrada é armazenado. |
example |
| Count |
string |
O número de imagens capturadas. |
1 |
| TileCount |
string |
O número de imagens no sprite de imagem. |
7 |
| UserData |
string |
Os dados personalizados do usuário. |
testid-001 |
| Code |
string |
O código de erro retornado quando o snapshot falha. Este parâmetro não é retornado se o trabalho for bem-sucedido. |
InvalidParameter |
| PipelineId |
string |
O ID da fila do MPS. |
b11c171cced04565b1f38f1ecc39**** |
| Id |
string |
O ID do trabalho de snapshot. |
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 dos IDs de trabalhos de snapshot inexistentes. Este parâmetro não é retornado se não houver dados disponíveis. |
c6d973c33d1c4b21bc39907d3b29**** |
|
| NextPageToken |
string |
O token para a próxima página, que é um UUID de 32 caracteres. Este parâmetro é retornado e atualizado a cada consulta quando os resultados da consulta excedem uma página. |
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.