PolarDB クラスターの DescribeExtensions API 概要 - PolarDB

拡張機能の詳細を取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeExtensions

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-**************
DBName	string	必須	データベース名。	song

レスポンスフィールド

フィールド	型	説明	例
	object	応答本文。
RequestId	string	リクエスト ID。	309073D4-9C99-511C-AF84-0C67A6F52E67
UninstalledExtensions	array<object>	指定されたデータベースにインストールされていない拡張機能。
	object	指定されたデータベースにインストールされていない拡張機能。
Name	string	拡張機能名。	jueming
DefaultVersion	string	拡張機能のデフォルトバージョン。	7.7
InstalledVersion	string	現在インストールされている拡張機能のバージョン。	7.7
Comment	string	拡張機能の目的。	OK
Owner	string	拡張機能のオーナー。	alton
Priority	string	拡張機能の優先度。	1
Requires	string	この拡張機能が依存する拡張機能。	ganos_networking
Category	string	拡張機能のタイプ。	geography_space, self_develop
Restart	string	アプリケーションを再起動するかどうかを指定します。`true`: アプリケーションは再起動されます。`false`: アプリケーションは再起動されません。	true
InstalledExtensions	array<object>	指定されたデータベースにインストールされている拡張機能。
	object	指定されたデータベースにインストールされている拡張機能。
Name	string	拡張機能名。	jueming
DefaultVersion	string	拡張機能のデフォルトバージョン。	7.7
InstalledVersion	string	現在インストールされている拡張機能のバージョン。	7.7
Comment	string	拡張機能の説明。	OK
Owner	string	拡張機能のオーナー。	alton
Priority	string	拡張機能の優先度。	1
Requires	string	この拡張機能が依存する拡張機能。	ganos_networking
Category	string	拡張機能のタイプ。	geography_space, self_develop
Restart	string	アプリケーションを再起動するかどうかを指定します。`true`: アプリケーションは再起動されます。`false`: アプリケーションは再起動されません。	true
Overview	string	拡張機能の概要。	测试建单，请忽略

例

成功レスポンス

JSONJSON

{
  "RequestId": "309073D4-9C99-511C-AF84-0C67A6F52E67",
  "UninstalledExtensions": [
    {
      "Name": "jueming",
      "DefaultVersion": "7.7",
      "InstalledVersion": "7.7",
      "Comment": "OK",
      "Owner": "alton",
      "Priority": "1",
      "Requires": "ganos_networking",
      "Category": "geography_space, self_develop",
      "Restart": "true"
    }
  ],
  "InstalledExtensions": [
    {
      "Name": "jueming",
      "DefaultVersion": "7.7",
      "InstalledVersion": "7.7",
      "Comment": "OK",
      "Owner": "alton",
      "Priority": "1",
      "Requires": "ganos_networking",
      "Category": "geography_space, self_develop\n",
      "Restart": "true"
    }
  ],
  "Overview": "测试建单，请忽略"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBInstance.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

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

変更履歴

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