DescribeFirstRank API で第一ランクソート式を取得 - OpenSearch

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

opensearch:DescribeFirstRank

*FirstRank

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

なし

リクエスト構文

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks/{name} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーションの名前です。	my_app_group_name
appId	integer	必須	アプリケーションのバージョン番号です。	110157886
name	string	必須	基本ソート式の名前です。	test

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID です。	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object	基本ソート式に関する情報です。
description	string	式の説明です。	-
active	boolean	式がデフォルトであるかどうかを示します。	false
name	string	式の名前です。	ar_wear_edit_time
meta	array<object>	式に関する情報です。
	object
arg	string	式内の関数で使用されるパラメーターです。	ar_edit_time
attribute	string	属性、スコアリング機能、または検索フィールドです。	timeliness_ms()
weight	number	重みです。有効な値: -100000～100000。値は 0 にはできません。	1

例

成功レスポンス

JSONJSON

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "description": "-",
    "active": false,
    "name": "ar_wear_edit_time",
    "meta": [
      {
        "arg": "ar_edit_time",
        "attribute": "timeliness_ms()",
        "weight": 1
      }
    ]
  }
}

エラーコード

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

変更履歴

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