Help Center> VAS> API Reference> Common Parameters> Query and Detail Parameters
View PDF

Query and Detail Parameters

queryOption

Parameter

Mandatory

Type

Description

order

No

String

A sorting rule for the returned results. The format is <attribute name>:<[ASC|DESC]>. ASC indicates sorting the results in ascending order, and DESC indicates descending. For example, name:ASC. Default to DESC.

Available to the following fields.
  • name: job name
  • created_at: job creation time
  • updated_at: job update time

service_version

No

String

Version, which consists of two numeric fields and a dot (.). The numeric fields are separated by the dot (.), for example, 1.0. Each field contains up to three digits, that is, xxx.xxx.

state

No

String
Job status. Possible values are as follows:
  • PENDING: The job is pending.
  • RECOVERING: The job is recovering.
  • STARTING: The job is starting.
  • UPGRADING: The job is being upgraded.
  • CREATE_FAILED: The job failed to be created.
  • START_FAILED: The job failed to be started.
  • RUNNING: The job is running.
  • STOPPING: The job is being stopped.
  • STOPPED: The job has been stopped.
  • ABNORMAL: The job is running abnormally.
  • SUCCEEDED: The job is executed successfully.
  • FAILED: The job failed to be executed.
  • DELETING: The job is being deleted.
  • FREEZING: The job is being frozen.
  • FROZEN: The job has been frozen.

offset

No

Integer

Start position of the query. Used together with limit. The value is an integer ranging from 1 to 100000.

  • This parameter is unavailable if page is set.
  • If neither offset nor limit are specified, all results are returned.

limit

No

Integer

Maximum number of results returned. Must be used together with offset. The value is an integer ranging from 1 to 100.

  • If page is specified, this parameter has no effect.
  • If neither offset nor limit are specified, all results are returned.

created_since

No

String

Timestamp when the query starts. The value is a millisecond-precise timestamp, for example, 1561607125000.

created_until

No

String

Timestamp when the query ends. The value is a millisecond-precise timestamp, for example, 1561607125000.

name_like

No

String

Name of the resource to be queried, for example, name.

id_like

No

String

ID of a queried resource, for example, f18320e61e4c4dc685aa2dfc22a28dc5.

task.detail

  • Parameters in task.detail

    Parameter

    Type

    Description

    id

    String

    Job ID

    name

    String

    Job name

    description

    String

    Job description. This parameter is left blank by default.

    state

    String
    Job status. Possible values are as follows:
    • PENDING: The job is pending.
    • RECOVERING: The job is recovering.
    • STARTING: The job is starting.
    • UPGRADING: The job is being upgraded.
    • CREATE_FAILED: The job failed to be created.
    • START_FAILED: The job failed to be started.
    • RUNNING: The job is running.
    • STOPPING: The job is being stopped.
    • STOPPED: The job has been stopped.
    • ABNORMAL: The job is running abnormally.
    • SUCCEEDED: The job is executed successfully.
    • FAILED: The job failed to be executed.
    • DELETING: The job is being deleted.
    • FREEZING: The job is being frozen.
    • FROZEN: The job has been frozen.

    created_at

    String

    Job creation time, in ISO 8601 format, that is, YYYY-MM-DDThh:mm:ssZ

    updated_at

    String

    Job update time, in ISO 8601 format, that is, YYYY-MM-DDThh:mm:ssZ

    input

    Object

    Data input list. Default to []. For type definition, see task.input.

    service_config

    Object

    Service algorithm configuration. The field structure is related to the service.

    output

    Object

    Data output list. Default to []. For type definition, see task.output.

    hosting_result

    Object

    Optional. This parameter is available only in the APIs for querying a single job when the output type is set to hosting. For type definition, see Data structure of the hosting_result field.

    service_version

    String

    Service version corresponding to a job.
  • Data structure of the hosting_result field

    Parameter

    Mandatory

    Type

    Description

    data

    No

    String

    Content of the result file result.json

    obs

    No

    Object

    OBS bucket where result files are stored and the path to result file result.json

    status

    No

    String
    Status of the results.json file. Possible values are as follows:
    • NOT_GENERATED: The file is not generated.
    • AVAILABLE: The file is available.
    • EXCEED_IN_SIZE: The file size exceeds the upper limit.
    • OVERDUE_DELETING: The file is being deleted due to expiration.
    • OVERDUE_DELETED: The file has been deleted due to expiration.
    • DELETED_MISTAKENLY: The file is deleted accidentally.

    result_json_overdue_at

    No

    String

    Expiration date of the result.json file. By default, the file is saved for 48 hours.
Parent topic: Common Parameters