このトピックでは、IncreaseList 操作の構文について説明し、操作の例を示します。 この操作を呼び出して、Image Search のインスタンスからバッチタスクをクエリできます。

説明

Image Search のインスタンスからバッチタスクをクエリする操作です。

QPS の制限

デフォルトでは、最大で 1 クエリの操作に対応しています。 この場合、システムは 1 秒あたり最大 1 リクエストを処理できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 便宜上、OpenAPI Explorer でこの操作を呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター名 データ型 必須／任意 例 説明
操作 String 必須 IncreaseList

実行する操作です。 値をIncreaseList に設定します。

InstanceName String 必須 demoinstance1

Image Search インスタンス名です。 名前は最大 20 文字です。

Id Long 任意 500

バッチタスクの ID です。

BucketName String 任意 BucketName

Object Storage Service (OSS) バケットの名前です。

パス String 任意 /xxx/xxx

バケット内の increment.meta ファイルへの絶対パスです。 パスの先頭はスラッシュ (/) である必要があります。末尾をスラッシュ (/) とすることはできません。

PageSize Integer 任意 10

返されるページごとの画像の数です。 デフォルト値は 10 です。

PageNumber Integer 任意 1

返されるページ数です。 デフォルト値は 1 です。

レスポンスパラメーター

パラメーター名 データ型 例 説明
RequestId String B3137727-7D6E-488C-BA21-0E034C38A879

リクエストの ID です。

Data オブジェクト

バッチタスクに関する情報です。

増分 インスタンスの配列

バッチタスクのリストです。

インスタンス
Msg String 成功

返されたエラーメッセージです。

ステータス String SUCCESS

バッチタスクのステータスです。

  • PROCESSING ：処理中
  • FAIL ：失敗
  • SUCCESS ：成功
UtcModified Long 1629095760000

タスクが作成された時刻です。 単位はミリ秒です。

BucketName String BucketName

Object Storage Service (OSS) バケットの名前です。

UtcCreate String 1629095713000

タスクが作成された時刻です。 単位はミリ秒です。

Code String 0

返されたエラーコードです。

  • 値が 0 の場合、操作は成功しています。
  • 値が 0 以外の場合はエラーが発生しています。
パス String /xx/xx

バケット内の increment.meta ファイルへの絶対パスです。 このパスはスラッシュ (/) で始まる必要があり、スラッシュ (/) で終わることはできません。

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

結果をダウンロードできるアドレスです。 アドレスは 2 時間有効です。

Id Long 500

タスクの ID です。

CallbackAddress String http://xxxxx

コールバックアドレスです。

PageSize Integer 10

各ページで返されるエントリ数です。

PageNumber Integer 1

返されるページ数です。

TotalCount Long 15

タスクの総数です。

例

リクエストの例

{
	"InstanceName":"xxxx",
  "Id":500,
  "PageSize":1,
  "PageNumber":1
}

成功レスポンスの例

JSON 形式 

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

{
  "data": {
    "increments" : {
      "instance" : [ {
        "bucketName" : "BucketName",
        "code" : "0",
        "errorUrl" : "https://imageSearchName.oss-cn-shanghai.aliyuncs.com/xxxx",
        "id" : 1257,
        "msg" : "success",
        "path" : "/xxx/xxx",
        "status" : "NORMAL",
        "utcCreate" : "1631067749000",
        "utcModified" : 1631068020000
      } ]
    },
    "pageNumber" : 1,
    "pageSize" : 1,
    "totalCount" : 43
  },
  "requestId" : "A4A84E43-BB93-13EA-9D02-B282035821C1"
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InvalidInstance The specified instance name is invalid. 指定されたインスタンス名が無効な場合に返されるエラーメッセージです。
400 Console.BadRequest The request has invalid parameters. リクエストが無効な場合に返されるエラーメッセージです。 リクエストパラメーターを確認してください。
400 Console.InstanceNotFound The specified ImageSearch instance is not found. インスタンスが見つからない場合に返されるエラーメッセージです。 インスタンスの ID を確認してください。
401 Console.LoginError Check login failed. ログインに失敗した場合に返されるエラーメッセージです。 ユーザー名、パスワード、メールアドレスを確認してください。
403 Console.NoPermission You are not authorized to this operation. 該当の操作を実行する権限がない場合に返されるエラーメッセージです。 管理者から必要な権限を取得してください。
409 Console.InstanceStatusError Current Instance status not supported this opreate. インスタンスが無効な場合に返されるエラーメッセージです。 インスタンスのステータスを確認してください。
409 Console.OrderStatusError Current Order status not supported this opreate. 注文が無効な場合に返されるエラーメッセージです。 注文のステータスを確認してください。
409 Console.IncrementStatusError Current Increment status not supported this opreate. 増分更新のステータスが無効な場合に返されるエラーメッセージです。 インスタンスの増分更新ステータスを確認してください。
500 Console.InternalError The request processing has failed due to some unknown error. サーバーエラーが発生した場合に返されるエラーメッセージです。 Alibaba Cloud 管理コンソールにログインし、チケットを起票してください。

エラーコードリストについては、「API エラーセンター」をご参照ください。

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。