CreateAppGroupCredentials API によるセキュア API アクセス用 App Group 認証情報生成 - 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:WriteAppGroupCredential

create

*AppGroupCredential

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

なし

リクエスト構文

POST /v4/openapi/app-groups/{appGroupIdentity}/credentials HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーショングループの ID です。	app_group_123

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
dryRun	boolean	任意	ドライランを実行するかどうかを指定します。ドライランでは、システムはリクエストパラメーターをチェックしますが、操作は実行しません。
body	object	任意	リクエスト本文。資格情報の種類などの情報が含まれます。
type	string	任意	資格情報の種類 (`api-key`、`account`、`invoke-key`、`api-token` など)。API キーを作成するには、このパラメーターを `api-token` に設定します。	api-token

レスポンスフィールド

フィールド	型	説明	例
	object	成功した応答の構造です。
requestId	string	リクエストの一意の ID です。	1-2-3-4
result	object	操作結果の詳細です。
appGroupId	integer	アプリケーショングループの ID です。	app_group_123
type	string	資格情報の種類です。	api-token
enabled	boolean	資格情報が有効かどうかを示します。
token	string	生成された資格情報トークンです。	generated_token_string

例

成功レスポンス

JSONJSON

{
  "requestId": "1-2-3-4",
  "result": {
    "appGroupId": 0,
    "type": "api-token",
    "enabled": false,
    "token": "generated_token_string"
  }
}

エラーコード

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

変更履歴

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