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

AnalyticDB:DescribeAppliedAdvices

最終更新日:Mar 30, 2026

DescribeAppliedAdvices を呼び出して、適用済みの最適化の提案を取得します。

今すぐお試しください

この 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:DescribeAppliedAdvices

get

DBCluster

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBClusterId

string

必須

AnalyticDB for MySQL Data Warehouse Edition クラスターの ID。

説明

AnalyticDB for MySQL Data Warehouse Edition クラスターの ID を照会するには、DescribeDBClusters API を呼び出します。

am-uf6g8w25jacm7****

RegionId

string

必須

リージョン ID。

説明

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

cn-hangzhou

StartTime

integer

任意

クエリ時間範囲の開始日。yyyyMMdd 形式で、協定世界時 (UTC) です。

20220811

EndTime

integer

任意

クエリ時間範囲の終了日。yyyyMMdd 形式で、協定世界時 (UTC) です。

20220824

Lang

string

任意

提案の言語。有効な値:

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

  • en: 英語

  • ja: 日本語

  • zh-tw: 繁体字中国語

zh

PageSize

integer

任意

1ページあたりのエントリ数。有効な値:

  • 30 (デフォルト)

  • 50

  • 100

30

PageNumber

integer

任意

ページ番号。値は 0 より大きい整数で、整数データ型の最大値を超えないようにする必要があります。デフォルト:1。

1

AdviceType

string

任意

返す提案の種類。有効な値:

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

  • TIERING: データ階層化。

INDEX

Keyword

string

任意

テーブル名であいまい検索を実行するためのキーワード。

you_table_name

SchemaTableName

string

任意

スキーマ名とテーブル名。値は <schema>.<table> 形式である必要があります。

tpch.lineitem

Order

string

任意

結果のソート順。値は、[{"Field":"SchemaName","Type":"Asc"}] のような JSON 文字列である必要があります。JSON 文字列には、次のフィールドが含まれます:

  • Field: 結果のソートに使用するフィールド。有効な値:
    • SchemaName: スキーマ名。

    • TableName: テーブル名。

    • JobStatus: テーブル構築ジョブのステータス。

    • SubmitTime: 提案が作成された時間。

    • Benefit: 期待される最適化効果。

  • Type: ソート順。有効な値:
    • Asc: 昇順。

    • Desc: 降順。

説明

このパラメーターが指定されていない場合、結果はデフォルトで作成時間 (SubmitTime) の降順でソートされます。

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

レスポンスフィールド

フィールド

説明

object

応答オブジェクト。

Items

array<object>

詳細。

object

提案。

AdviceId

string

提案 ID。

7417db9c-914d-43f3-a123-4d0e448f****

SubmitTime

string

送信時間。この値は yyMMddHHmm 形式の協定世界時 (UTC) です。

2208131600

SubmitStatus

string

送信ステータス。 有効な値:

  • SUCCEED: 送信は成功です。

  • FAILED: 送信は失敗です。

SUCCEED

SQL

string

提案を適用するために使用される SQL ステートメント。

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

RollbackSQL

string

提案をロールバックするために使用される SQL ステートメント。

alter table `schema1`.`table1` add key col1_1_idx(col1)

JobStatus

string

提案を適用するために実行されるタスクの状態。 有効な値:

  • SUCCEED: タスクは成功です。

  • FAILED: タスクは失敗です。

SUCCEED

Benefit

string

提案の効果。

节省0.4 GB的存储空间

BuildSQL

string

構築タスクを実行するために使用される SQL ステートメント。

build table `schema1`.`table1`

TotalCount

integer

返された提案の総数。値は 0 以上の整数です。デフォルト値:0。

1

PageSize

integer

1ページあたりのエントリ数。 有効な値:

  • 30 (デフォルト)

  • 50

  • 100

30

PageNumber

integer

ページ番号。値は 0 より大きい整数です。デフォルト値:1。

1

SchemaName

string

データベース名。

adb_demo

TableName

string

テーブル名。

test

IndexFields

string

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

index

PageNumber

integer

ページ番号。値は 0 より大きい整数です。デフォルト値:1。

1

PageSize

integer

1ページあたりのエントリ数。 有効な値:

  • 30 (デフォルト)

  • 50

  • 100

30

RequestId

string

リクエスト ID。

84489769-3065-5A28-A4CB-977CD426F1C3

TotalCount

integer

返された結果の総数。値は 0 以上の整数です。デフォルト値:0。

1

SchemaTableNames

array

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

string

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

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

成功レスポンス

JSONJSON

{
  "Items": [
    {
      "AdviceId": "7417db9c-914d-43f3-a123-4d0e448f****",
      "SubmitTime": "2208131600",
      "SubmitStatus": "SUCCEED",
      "SQL": "alter table `schema1`.`table1` drop key col1_1_idx",
      "RollbackSQL": "alter table `schema1`.`table1` add key col1_1_idx(col1)",
      "JobStatus": "SUCCEED",
      "Benefit": "节省0.4 GB的存储空间",
      "BuildSQL": "build table `schema1`.`table1`",
      "TotalCount": 1,
      "PageSize": 30,
      "PageNumber": 1,
      "SchemaName": "adb_demo",
      "TableName": "test",
      "IndexFields": "index"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "84489769-3065-5A28-A4CB-977CD426F1C3",
  "TotalCount": 1,
  "SchemaTableNames": [
    "[\n  \"tpch.lineitem\",\n  \"tpch.partsupp\",\n  \"tpch.orders\"\n]"
  ]
}

エラーコード

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

変更履歴

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