すべてのプロダクト
Search
ドキュメントセンター

AnalyticDB:DescribeAvailableAdvices

最終更新日:Mar 30, 2026

DescribeAvailableAdvices を使用して、最適化に関するアドバイスを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeAvailableAdvices

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBClusterId

string

必須

クラスターの ID です。

説明

利用可能な Data Warehouse Edition クラスターの ID を照会するには、DescribeDBClusters API を呼び出します。

am-bp198m028ih55****

RegionId

string

必須

リージョン ID です。

説明

利用可能なリージョンの ID を照会するには、DescribeRegions API を呼び出します。

cn-hangzhou

AdviceDate

integer

必須

アドバイスが生成された日付(UTC 時間、yyyyMMdd 形式)です。

説明

アドバイスは、早朝に実行される分析処理の後に毎日生成されます。アドバイスを照会するには、現在日付の前日(T−1)以降の日付を指定する必要があります。たとえば、現在日付が 20240627 の場合、20240626 またはそれより前の日付を指定してください。

20221124

Lang

string

必須

アドバイスの言語を指定します。有効な値は以下のとおりです。

  • zh: 簡体字中国語(デフォルト)

  • en: 英語

  • ja: 日本語

  • zh-tw: 繁体字中国語

zh

PageSize

integer

必須

1 ページあたりの表示件数を指定します。有効な値は以下のとおりです。

  • 30(デフォルト)

  • 50

  • 100

30

PageNumber

integer

必須

ページ番号を指定します。正の整数を指定する必要があります。デフォルト値は 1 です。

1

AdviceType

string

任意

アドバイスの種別を指定します。有効な値は以下のとおりです。

  • INDEX: インデックス最適化

  • TIERING: データ階層化最適化

Index

Keyword

string

任意

テーブル名によるあいまい検索のキーワードです。

you_table_name

SchemaTableName

string

任意

データベース名とテーブル名を連結した文字列です。

tpch.lineitem

Order

string

任意

クエリ結果の並べ替え順序を指定します。値は JSON 文字列で、例: [{"Field":"SchemaName","Type":"Asc"}]。JSON 文字列には以下のパラメーターが含まれます。

  • Field: 並べ替え対象のフィールド。有効な値:
    • SchemaName: データベース名

    • TableName: テーブル名

    • Benefit: 期待される効果

  • Type: 並べ替え順序。有効な値:
    • Asc: 昇順

    • Desc: 降順

説明

デフォルトでは、期待される効果(Benefit)を基準に降順で並べ替えられます。

[{"Field":"Benefit","Type":"Desc"}]

レスポンスフィールド

フィールド

説明

object

応答オブジェクトです。

Items

array<object>

詳細情報です。

object

アドバイスの一覧です。

AdviceId

string

アドバイスの ID です。

dcd04135-0925-4aed-a5a7-e7d92cb1****

AdviceDate

string

アドバイスが生成された日付です(yyyyMMdd 形式、UTC 時間)。

20221124

AdviceType

string

アドバイスの種別です。有効な値は以下のとおりです。

  • Index: インデックス最適化

  • Tiering: ホットデータおよびコールドデータの最適化

Index

SQL

string

アドバイスを適用するための SQL ステートメントです。

alter table `schema1`.`table1` drop key col1_1_idx

Reason

string

この最適化アドバイスが生成された理由です。

15天未使用,历史使用统计概率小于1%

Benefit

string

アドバイスによる効果です。

节省0.4 GB的存储空间。

TotalCount

integer

返されたアドバイスの総件数です。値は 0 以上であり、Integer 型の最大値を超えることはありません。デフォルト値は 0 です。

30

PageSize

integer

1 ページあたりの表示件数を指定します。有効な値は以下のとおりです。

  • 30(デフォルト)

  • 50

  • 100

30

PageNumber

integer

ページ番号を指定します。値は 0 より大きく、Integer 型の最大値を超えることはありません。デフォルト値は 1 です。

1

SchemaName

string

データベース名です。

adb_demo

TableName

string

テーブル名です。

test_table

IndexFields

string

インデックスフィールドです。

index

PageNumber

integer

ページ番号を指定します。値は 0 より大きく、Integer 型の最大値を超えることはありません。デフォルト値は 1 です。

1

PageSize

integer

1 ページあたりの表示件数を指定します。有効な値は以下のとおりです。

  • 30(デフォルト)

  • 50

  • 100

30

RequestId

string

リクエスト ID です。

96A55627-28E9-5E47-B8F6-D786BE551349

TotalCount

integer

返された結果の総件数です。値は 0 以上であり、Integer 型の最大値を超えることはありません。デフォルト値は 0 です。

30

SchemaTableNames

array

データベース名とテーブル名を連結した文字列のリストです。

string

データベース名とテーブル名を連結した文字列です。

[ "tpch.lineitem", "tpch.partsupp", "tpch.orders" ]

成功レスポンス

JSONJSON

{
  "Items": [
    {
      "AdviceId": "dcd04135-0925-4aed-a5a7-e7d92cb1****",
      "AdviceDate": "20221124",
      "AdviceType": "Index",
      "SQL": "alter table `schema1`.`table1` drop key col1_1_idx",
      "Reason": "15天未使用,历史使用统计概率小于1%",
      "Benefit": "节省0.4 GB的存储空间。",
      "TotalCount": 30,
      "PageSize": 30,
      "PageNumber": 1,
      "SchemaName": "adb_demo",
      "TableName": "test_table",
      "IndexFields": "index"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "96A55627-28E9-5E47-B8F6-D786BE551349",
  "TotalCount": 30,
  "SchemaTableNames": [
    "[\n  \"tpch.lineitem\",\n  \"tpch.partsupp\",\n  \"tpch.orders\"\n]"
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 MissingParameter.PageSize The PageSize parameter is required.

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

変更履歴

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