ListRecognitionSamples API 概要 - IMS

操作説明

この API 呼び出しは、中国 (北京)、中国 (上海)、中国 (杭州)、および中国 (深セン) リージョンでのみ利用可能です。
この API 呼び出しの 1 ユーザーあたりの秒間クエリ数 (QPS) の上限は 50 です。この上限を超えると、API 呼び出しがスロットルされ、ビジネスに影響を与える可能性があります。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ice:ListRecognitionSamples

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Algorithm	string	必須	認識タイプ。有効な値： landmark: カスタムランドマーク。 object: カスタムオブジェクト。 logo: カスタムロゴ。 face: カスタム顔。 label: カスタムタグ。	landmark
LibId	string	必須	ライブラリ ID。このパラメーターを指定すると、システムは完全に一致するものを検索します。複数のライブラリ ID を指定できます。コンマ (,) で区切ります。	lib1,lib2,lib3
EntityId	string	必須	エンティティ ID。このパラメーターを ANY に設定すると、システムは EntityName で照会します。	************544cb84754**********
PageNumber	integer	必須	ページ番号。	1
PageSize	integer	必須	各ページで返されるレコード数。	10
EntityName	string	任意	エンティティ名。	custom_person

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	****11-DB8D-4A9A-875B-275798****
PageNumber	integer	ページ番号。	1
PageSize	integer	各ページで返されるレコード数。	20
TotalCount	integer	サンプルの総数。	5
Samples	object
Sample	array<object>	サンプルリスト。
	object	サンプル。
SampleId	string	サンプル ID。	************4d2ba728e2f************
ImageUrl	string	サンプルイメージの URL。	https://example.com/sample.png
EntityId	string	エンティティ ID。	*****49ff-9b15****
LibId	string	エンティティライブラリ ID。	********23da4529998**********

例

成功レスポンス

JSONJSON

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 5,
  "Samples": {
    "Sample": [
      {
        "SampleId": "**************4d2ba728e2f**************",
        "ImageUrl": "https://example.com/sample.png",
        "EntityId": "*******49ff-9b15******",
        "LibId": "**********23da4529998************"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	errorMsg:%s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。