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

Notas de uso

Esta operação permite consultar até 10 jobs de snapshot por vez.

Limites de QPS

O limite desta operação é de 100 chamadas por segundo por conta. Se o número de chamadas por segundo ultrapassar esse valor, o throttling será acionado, o que pode afetar seus negócios. Recomendamos observar esse limite ao chamar esta operação. Para mais informações, consulte Limite de QPS.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QuerySnapshotJobList	Operação a ser executada. Defina o valor como QuerySnapshotJobList.
SnapshotJobIds	String	Não	72dfa5e679ab4be9a3ed9974c736****	IDs dos jobs de snapshot a serem consultados. Para obter os IDs, faça login no ApsaraVideo Media Processing (MPS) console, clique em Tasks no painel de navegação à esquerda e visualize os IDs na aba Snapshot. É possível consultar até 10 jobs de snapshot por vez. Separe os IDs com vírgulas (,).
NextPageToken	String	Não	cc6cbef8e8d5481ca536f5d2a466****	Token usado para recuperar a próxima página dos resultados da consulta. O valor é um UUID de 32 bits. Este parâmetro é retornado quando os resultados não cabem em uma única página e seu valor é atualizado a cada consulta.
MaximumPageSize	Long	Não	30	Número máximo de entradas a retornar em cada página. Valor padrão: 30. Valores válidos: [1.300].
State	String	Não	Snapshoting	Status dos jobs de snapshot a serem consultados. Submitted: job enviado. Snapshoting: job em processamento. Success: job processado com sucesso. Fail: falha no job.
StartOfJobCreatedTimeRange	String	Não	2014-01-10T12:00:00Z	Início do intervalo de tempo de criação dos jobs de snapshot a serem consultados. Especifique a hora no padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ. A hora deve estar em UTC.
EndOfJobCreatedTimeRange	String	Não	2014-01-12T12:00:00Z	Fim do intervalo de tempo de criação dos jobs de snapshot a serem consultados. Especifique a hora no padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ. A hora deve estar em UTC.
PipelineId	String	Não	b11c171cced04565b1f38f1ecc39****	ID da fila do MPS onde os jobs de snapshot a serem consultados foram enviados. Para obter o ID, faça login no MPS console e escolha Global Settings > Pipelines no painel de navegação à esquerda.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
SnapshotJobList	Array of SnapshotJob		Informações sobre os jobs de snapshot.
SnapshotJob
CreationTime	String	2021-06-30T12:34:29Z	Hora de criação do job.
SnapshotConfig	Object		Configuração do snapshot.
Time	String	4	Tempo inicial para captura dos snapshots. Unidade: milissegundos.
TileOut	Object		Configuração de mosaico.
Padding	String	0	Distância entre as imagens. Valor padrão: 0. Unidade: pixel.
Color	String	black	Cor de fundo. Valor padrão: black. Defina o parâmetro Color como uma palavra-chave de cor ou random na solicitação. Nota Para definir a cor de fundo como preto, especifique a palavra-chave de cor em um dos três formatos a seguir: Black, black ou #000000.
CellSelStep	String	3	Passo de uma única imagem.
CellHeight	String	8	Altura de uma única imagem. O valor padrão corresponde à altura do snapshot de saída.
CellWidth	String	8	Largura de uma única imagem. O valor padrão corresponde à largura do snapshot de saída.
Margin	String	0	Largura da margem da imagem em mosaico. Valor padrão: 0. Unidade: pixel.
Columns	String	10	Número de colunas na imagem em mosaico. Valor padrão: 10.
IsKeepCellPic	String	false	Indica se as imagens individuais são mantidas. Valor padrão: true.
Lines	String	10	Número de linhas na imagem em mosaico. Valor padrão: 10.
Interval	String	10	Intervalo para captura dos snapshots. Se o parâmetro Interval for especificado na solicitação, os snapshots serão capturados em intervalos regulares. O valor deve ser maior que 0. Unidade: segundos. Valor padrão: 10.
FrameType	String	intra	Tipo do snapshot. Valores válidos: normal: quadros normais. intra: I-frames. Valor padrão: intra.
Width	String	8	Largura do snapshot de saída.
Height	String	8	Altura do snapshot de saída.
OutputFile	Object		Arquivo de saída do Object Storage Service (OSS) do job de snapshot.
RoleArn	String	acs:ram::1:role/testrole	Alibaba Cloud Resource Name (ARN) da função RAM especificada. Formato: acs:ram::$accountID:role/$roleName.
Object	String	example.png	Objeto OSS gerado como arquivo de saída do job de snapshot.
Location	String	example-location	ID da região onde o bucket OSS de saída está localizado.
Bucket	String	example	Bucket OSS que armazena o arquivo de saída.
Num	String	10	Quantidade de snapshots a capturar. Se o parâmetro Num for definido na solicitação, os snapshots serão capturados em intervalos.
TileOutputFile	Object		Arquivo de saída OSS do job de mosaico.
RoleArn	String	acs:ram::1:role/testrole	ARN da função RAM especificada. Formato: acs:ram::$accountID:role/$roleName.
Object	String	example.png	Objeto OSS gerado como arquivo de saída do job de mosaico.
Location	String	example-location	ID da região onde o bucket OSS de saída está localizado.
Bucket	String	example	Bucket OSS que armazena o arquivo de saída.
State	String	Snapshoting	Status do job de snapshot. Submitted: job enviado. Snapshoting: job em processamento. Success: job processado com sucesso. Fail: falha no job.
Message	String	The resource operated InputFile is bad	Mensagem de erro retornada quando o job falha. Este parâmetro não é retornado se o job for processado com sucesso.
MNSMessageResult	Object		Mensagem enviada pelo MNS para notificar o usuário sobre o resultado do job.
MessageId	String	799454621135656C7F815F198A76****	ID da mensagem. Este parâmetro não é retornado se o job falhar.
ErrorMessage	String	The resource operated InputFile is bad	Mensagem de erro retornada quando o job falha. Este parâmetro não é retornado se o job for processado com sucesso.
ErrorCode	String	InvalidParameter	Código de erro retornado quando o job falha. Este parâmetro não é retornado se o job for processado com sucesso.
Input	Object		Informações sobre a entrada do job.
RoleArn	String	acs:ram::1:role/testrole	ARN da função RAM especificada. Formato: acs:ram::$accountID:role/$roleName.
Object	String	example.flv	Objeto OSS usado como arquivo de entrada.
Location	String	example-location	ID da região onde o bucket OSS de entrada está localizado.
Bucket	String	example	Bucket OSS que armazena o arquivo de entrada.
Count	String	1	Número de snapshots capturados.
TileCount	String	7	Quantidade de snapshots contidos na imagem em mosaico.
UserData	String	testid-001	Dados personalizados.
Code	String	InvalidParameter	Código de erro retornado quando o job falha. Este parâmetro não é retornado se o job for processado com sucesso.
PipelineId	String	b11c171cced04565b1f38f1ecc39****	ID da fila do MPS onde o job de snapshot foi enviado.
Id	String	cc6cbef8e8d5481ca536f5d2a466****	ID do job de snapshot.
RequestId	String	34BCAB31-2833-43A7-9FBD-B34302AB23EQ	ID da solicitação.
NonExistSnapshotJobIds	Array of String	c6d973c33d1c4b21bc39907d3b29****	IDs dos jobs de snapshot inexistentes. Este parâmetro não é retornado se todos os jobs de snapshot especificados forem encontrados.
NextPageToken	String	b11c171cced04565b1f38f1ecc39****	Token usado para recuperar a próxima página dos resultados da consulta. O valor é um UUID de 32 bits. Este parâmetro é retornado quando os resultados não cabem em uma única página e seu valor é atualizado a cada consulta.

Exemplos

Exemplos de solicitações

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=QuerySnapshotJobList
&SnapshotJobIds=72dfa5e679ab4be9a3ed9974c736****
&NextPageToken=cc6cbef8e8d5481ca536f5d2a466****
&MaximumPageSize=30
&State=Snapshoting
&StartOfJobCreatedTimeRange=2014-01-10T12:00:00Z
&EndOfJobCreatedTimeRange=2014-01-12T12:00:00Z
&PipelineId=b11c171cced04565b1f38f1ecc39****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<QuerySnapshotJobListResponse>
    <SnapshotJobList>
        <CreationTime>2021-06-30T12:34:29Z</CreationTime>
        <SnapshotConfig>
            <Time>4</Time>
            <TileOut>
                <Padding>0</Padding>
                <Color>black</Color>
                <CellSelStep>3</CellSelStep>
                <CellHeight>8</CellHeight>
                <CellWidth>8</CellWidth>
                <Margin>0</Margin>
                <Columns>10</Columns>
                <IsKeepCellPic>false</IsKeepCellPic>
                <Lines>10</Lines>
            </TileOut>
            <Interval>10</Interval>
            <FrameType>intra</FrameType>
            <Width>8</Width>
            <Height>8</Height>
            <OutputFile>
                <RoleArn>acs:ram::1:role/testrole</RoleArn>
                <Object>example.png</Object>
                <Location>example-location</Location>
                <Bucket>example</Bucket>
            </OutputFile>
            <Num>10</Num>
            <TileOutputFile>
                <RoleArn>acs:ram::1:role/testrole</RoleArn>
                <Object>example.png</Object>
                <Location>example-location</Location>
                <Bucket>example</Bucket>
            </TileOutputFile>
        </SnapshotConfig>
        <State>Snapshoting</State>
        <MNSMessageResult>
            <MessageId>799454621135656C7F815F198A76****</MessageId>
        </MNSMessageResult>
        <Input>
            <RoleArn>acs:ram::1:role/testrole</RoleArn>
            <Object>example.flv</Object>
            <Location>example-location</Location>
            <Bucket>example</Bucket>
        </Input>
        <Count>1</Count>
        <TileCount>7</TileCount>
        <UserData>testid-001</UserData>
        <PipelineId>b11c171cced04565b1f38f1ecc39****</PipelineId>
        <Id>cc6cbef8e8d5481ca536f5d2a466****</Id>
    </SnapshotJobList>
    <RequestId>34BCAB31-2833-43A7-9FBD-B34302AB23EQ</RequestId>
    <NonExistSnapshotJobIds>c6d973c33d1c4b21bc39907d3b29****</NonExistSnapshotJobIds>
    <NextPageToken>b11c171cced04565b1f38f1ecc39****</NextPageToken>
</QuerySnapshotJobListResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
    "SnapshotJobList": [
        {
            "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"
                }
            },
            "State": "Snapshoting",,
            "MNSMessageResult": {
                "MessageId": "799454621135656C7F815F198A76****",
            },
            "Input": {
                "RoleArn": "acs:ram::1:role/testrole",
                "Object": "example.flv",
                "Location": "example-location",
                "Bucket": "example"
            },
            "Count": "1",
            "TileCount": "7",
            "UserData": "testid-001",
            "PipelineId": "b11c171cced04565b1f38f1ecc39****",
            "Id": "cc6cbef8e8d5481ca536f5d2a466****"
        }
    ],
    "RequestId": "34BCAB31-2833-43A7-9FBD-B34302AB23EQ",
    "NonExistSnapshotJobIds": [
        "c6d973c33d1c4b21bc39907d3b29****"
    ],
    "NextPageToken": "b11c171cced04565b1f38f1ecc39****"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.