DescribeSecondRank 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:DescribeSecondRank

*SecondRank

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーショングループの名前。	my_app_group_name
appId	integer	必須	API バージョン。	110157886
name	string	必須	セカンドランク式の名前。	test

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

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

レスポンスフィールド

フィールド	型	説明	例
	object
requestId	string	リクエスト ID。	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object	セカンドランク式の詳細。
created	integer	式が作成された時間。	1587052801
active	boolean	式がアクティブであるかどうかを示します。	true
isDefault	string	式がデフォルトであるかどうかを示します。このパラメーターは応答でのみ返されます。 true false	true
isSys	string	式がシステム式であるかどうかを示します。このパラメーターは応答でのみ返されます。 true false	false
description	string	説明。	-
updated	integer	式が更新された時間。	1587052801
name	string	式の名前。	tests
meta	string	セカンドランク式。フィールド、特徴関数、および数学関数を含む式を記述して、複雑なソートロジックを実装できます。	random()+now()
id	string	式の ID。このパラメーターは応答でのみ返されます。	89047

例

成功レスポンス

JSONJSON

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "created": 1587052801,
    "active": true,
    "isDefault": "true",
    "isSys": "false",
    "description": "-",
    "updated": 1587052801,
    "name": "tests",
    "meta": "random()+now()",
    "id": "89047"
  }
}

エラーコード

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

変更履歴

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