GetFunctionDefaultInstance 概要 - 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:DescribeFunction

get

*FunctionDefaultInstance

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

なし

リクエスト構文

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/default-instance HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーションの名前。	my_app_group_name
functionName	string	必須	機能の名前。	ctr

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

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

リクエストの例

GET /v4/openapi/app-groups/my-app/functions/pop/default-instances

レスポンスフィールド

フィールド	型	説明	例
	object	応答本文。
Status	string	リクエストのステータス。	OK
HttpCode	integer	HTTP ステータスコード。	200
RequestId	string	リクエスト ID。	062BA91F-A568-5779-8A5B-9E62C9BB3DC1
Message	string	エラーメッセージ。	default instance not set.
Code	string	エラーコード。	DefaultInstance.NotExist
Result	object	結果。	{'Pagination': {'TotalCount': 0, 'PageNumber': 1, 'PageSize': 10}, 'AntConsortiums': []}
InstanceName	string	デフォルトのインスタンス名。	model1
Latency	integer	デフォルトのランタイム。	123
InstanceName	string	インスタンスの名前。	sh-bp1oi31w1jn4ctdyv
FunctionName	string	機能の名前。	cdn_waf

応答の例

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
        "instanceName": "pop_test"
    }
}

例

成功レスポンス

JSONJSON

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "062BA91F-A568-5779-8A5B-9E62C9BB3DC1",
  "Message": "default instance not set.",
  "Code": "DefaultInstance.NotExist",
  "Result": {
    "InstanceName": "model1"
  },
  "Latency": 123,
  "InstanceName": "sh-bp1oi31w1jn4ctdyv",
  "FunctionName": "cdn_waf"
}

エラーコード

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

変更履歴

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