All Products
Search
Document Center

Image Search:DumpMetaList

Last Updated:Sep 25, 2023

This topic describes the syntax of the DumpMetaList operation and provides examples of this operation. You can call this operation to query tasks that are used for exporting metadata from an Image Search instance.

Description

This operation queries tasks that are used for exporting metadata from an Image Search instance.

QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Name

Type

Required

Example

Description

Action

String

Yes

DumpMetaList

The operation that you want to perform. Set the value to DumpMetaList.

InstanceName

String

Yes

demoinstance1

The name of the Image Search instance. The name can be up to 20 characters in length.

Id

Long

No

500

The ID of the export task.

Note

To export the task ID, it is necessary to first perform DumpMeta from the returned value.

PageSize

Integer

No

10

The number of images to return on each page. Default value: 10. Maximum value of 30.

PageNumber

Integer

No

1

The number of the page to return. Default value: 1.

Response parameters

Name

Type

Example

Description

RequestId

String

B3137727-7D6E-488C-BA21-0E034C38A879

The ID of the request.

Data

Object

The information about the task that is used to export metadata.

DumpMetaList

Array of Instance

A list of tasks that are used to export metadata.

Status

String

SUCCESS

The status of the export task.

  • PROCESSING: in progress

  • FAIL: failed

  • SUCCESS: successful

Msg

String

success

The error message returned.

UtcModified

Long

1629095760000

The time when the task was updated. Unit: milliseconds.

MetaUrl

String

https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx

The address where you can download the metadata. The address is valid for 2 hours.

UtcCreate

String

1629095713000

The time when the task was created. Unit: milliseconds.

Code

String

0

The error code returned.

  • A value of 0 indicates that the operation is successful.

  • Values other than 0 indicate errors.

Id

Long

500

The ID of the task.

PageSize

Integer

10

The number of entries to return on each page.

PageNumber

Integer

1

The number of the page to return.

TotalCount

Long

15

The total number of tasks.

Examples

Sample requests

{
  "InstanceName": "demoinstance"
  "PageSize": 10,
  "PageNumber": 1
}

Sample success responses

JSON format

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

{
  "RequestId" : "4F0FFFFE-506F-1DE4-9555-9BCFE54E05AE",
  "Data" : {
    "TotalCount" : 15,
    "PageSize" : 1,
    "PageNumber" : 1,
    "DumpMetaList" : [ {
      "Status" : "SUCCESS",
      "Msg" : "success",
      "MetaUrl" : "https://imageSearchname.oss-cn-shanghai.aliyuncs.com/**********",
      "UtcCreate" : 1629095713000,
      "UtcModified" : 1629095760000,
      "Id" : 497,
      "Code" : "0"
    } ]
  }
}

Error codes

HttpCode

Error code

Error message

Description

400

InvalidInstance

The specified instance name is invalid.

The error message returned because the instance name is invalid.

400

Console.BadRequest

The request has invalid parameters.

The error message returned because the request is invalid. Check the request parameters.

400

Console.InstanceNotFound

The specified ImageSearch instance is not found.

The error message returned because the instance cannot be found. Check the instance ID.

401

Console.LoginError

Check login failed.

The error message returned because the logon failed. Check the username, password, and email address.

403

Console.NoPermission

You are not authorized to this operation.

The error message returned because you are not authorized to perform this operation. Acquire the required permissions from the administrator.

409

Console.InstanceStatusError

Current Instance status not supported this opreate.

The error message returned because the instance is in an invalid state. Check the instance status.

409

Console.OrderStatusError

Current Order status not supported this opreate.

The error message returned because the order is invalid. Check the status of the order.

409

Console.IncrementStatusError

Current Increment status not supported this opreate.

The error message returned because the incremental update status is invalid. Check the incremental update status of the instance.

500

Console.InternalError

The request processing has failed due to some unknown error.

The error message returned because a server error occurred. Log on to the Alibaba Cloud Management Console and submit a ticket.

500

Console.CallServiceError

An internal service error occurred.

The error message returned because an internal error occurred.

For a list of error codes, visit the API Error Center.

Error codes

For a list of error codes, visit the API Error Center.