すべてのプロダクト
Search

このプロダクト

    :CreateStorageAnalysisTask

    ドキュメントセンター

    :CreateStorageAnalysisTask

    最終更新日:Mar 13, 2026

    1 つ以上のデータベースおよびテーブルの使用量詳細をクエリするためのストレージ分析タスクを作成します。

    操作説明

    • この操作は、ApsaraDB RDS for MySQL インスタンス、PolarDB for MySQL クラスター、および ApsaraDB for MongoDB インスタンスにのみ適用されます。

    • ApsaraDB RDS for MySQL インスタンスおよび PolarDB for MySQL クラスターでは、この操作は旧バージョンのストレージ分析機能と同様に動作します。この操作で生成されたタスクは、Database Autonomy Service (DAS) コンソールの新バージョンにおける「ストレージ分析」ページでは表示されません。タスクおよびその結果を確認する場合は、関連する API オペレーションを呼び出してデータを取得し、ローカル環境に保存してください。

    • Alibaba Cloud SDK または DAS SDK を使用してこの操作を呼び出す場合、最新版の SDK をご使用いただくことを推奨します。

    • DAS の API オペレーションを SDK から呼び出す場合、リージョン ID を cn-shanghai に設定する必要があります。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hdm:CreateStorageAnalysisTask

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンス ID。

    rm-2ze1jdv45i7l6****
    NodeId

    string

    任意

    ノード ID。ApsaraDB for MongoDB インスタンスでは、このパラメーターを使用してストレージ分析対象のノードを指定できます。ApsaraDB for MongoDB インスタンスのノード情報を照会するには、DescribeRoleZoneInfo オペレーションを呼び出してください。

    • このパラメーターを InsName 形式（例：d-bp1872fa24d5****）で指定した場合、対応するノード ID に紐づく隠しノードの分析が実行されます。

    • このパラメーターを InsName#RoleId 形式（例：d-bp1872fa24d5****#299****5）で指定した場合、指定されたノードの分析が実行されます。

    説明

    ApsaraDB for MongoDB レプリカセットインスタンスでストレージ分析タスクを実行する際、このパラメーターを指定しない場合は、デフォルトでインスタンスの隠しノードのみが分析対象となります。また、ApsaraDB for MongoDB シャードクラスターインスタンスでストレージ分析タスクを実行する場合は、このパラメーターを明示的に指定することを推奨します。

    d-bp1872fa24d5****
    DbName

    string

    任意

    データベース名。データベースを指定した場合、そのデータベースのストレージ使用量が分析されます。

    testdb01
    TableName

    string

    任意

    テーブル名。指定されたデータベース内のテーブルを指定した場合、そのテーブルのストレージ使用量が分析されます。テーブルを指定する場合は、必ず DbName を使用して、そのテーブルが属するデータベースも併せて指定する必要があります。

    test_table

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    integer

    返された HTTP ステータスコード。

    200
    Message

    string

    返されたメッセージ。

    説明

    リクエストが成功した場合、「Successful」が返されます。失敗した場合は、エラーコードなどのエラーメッセージが返されます。

    Successful
    Data

    object

    返されたデータ。

    TaskId

    string

    タスク ID。

    910f83f4b96df0524ddc5749f61539f8
    CreateTaskSuccess

    boolean

    タスクの作成成否を示します。有効な値：

    • true

    • false

    false
    ErrorMessage

    string

    返されたエラーメッセージ。

    unknown error
    RequestId

    string

    リクエスト ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    boolean

    リクエストの成功／失敗を示します。有効な値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TaskId": "910f83f4b96df0524ddc5749f61539f8",
    "CreateTaskSuccess": false,
    "ErrorMessage": "unknown error"
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

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

    変更履歴

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