すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:EvaluateResource

    ドキュメントセンター

    ApsaraDB for MongoDB:EvaluateResource

    最終更新日:Jan 30, 2026

    新しいインスタンスの購入、または既存インスタンスのスペックアップやスペックダウンの前に、十分なリソースが利用可能かどうかを評価します。

    操作説明

    この操作は、MongoDB のレプリカセットインスタンスとシャードクラスターインスタンスのリソースを評価します。インスタンスの購入、インスタンスのスペックアップまたはスペックダウン、シャードクラスターへのノードの追加などのシナリオでリソースを評価できます。

    説明

    この操作は、1 分あたり最大 200 回呼び出すことができます。この制限を超えた呼び出しは、速度制限の対象となります。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:EvaluateResource

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。詳細については、「DescribeRegions」をご参照ください。

    cn-hangzhou
    ZoneId

    string

    必須

    ゾーン ID。詳細については、「DescribeRegions」をご参照ください。

    cn-hangzhou-h
    Engine

    string

    任意

    データベースエンジン。値を MongoDB に設定します。

    MongoDB
    EngineVersion

    string

    必須

    データベースエンジンのバージョン。

    4.2
    DBInstanceClass

    string

    任意

    インスタンスタイプ。

    説明

    このパラメーターは、レプリカセットインスタンスのリソースを評価する場合に必要です。インスタンスタイプの詳細については、「インスタンスタイプ」をご参照ください。

    dds.mongo.mid
    ShardsInfo

    string

    任意

    シャードクラスターのシャード情報。このパラメーターは、シャードクラスターインスタンスのリソースを評価する場合に必要です。

    新しいシャードクラスターインスタンスのリソースを評価するには、JSON 文字列で各シャードのインスタンスタイプを指定します。例：

    {
     "ConfigSvrs":
         [{"Storage":20,"DBInstanceClass":"dds.cs.mid"}],
     "Mongos":
         [{"DBInstanceClass":"dds.mongos.standard"},{"DBInstanceClass":"dds.mongos.standard"}],
     "Shards":
         [{"Storage":50,"DBInstanceClass":"dds.shard.standard"},{"Storage":50,"DBInstanceClass":"dds.shard.standard"},   {"Storage":50,"DBInstanceClass":"dds.shard.standard"}]
 }

    この例のパラメーターは、次のように説明されています：

    • ConfigSvrs：ConfigServer ノード。

    • Mongos：Mongos ノード。

    • Shards：シャードノード。

    • Storage：ターゲットシャードのストレージ容量。

    • DBInstanceClass：ターゲットシャードのインスタンスタイプ。インスタンスタイプの詳細については、「シャードクラスターインスタンスタイプ」をご参照ください。

    シャードクラスターインスタンスのスペックアップまたはスペックダウンのリソースを評価するには、JSON 文字列でノード情報のみを指定します。例：

    {
     "NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"
}

    この例のパラメーターは、次のように説明されています：

    {"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"}
    DBInstanceId

    string

    任意

    インスタンス ID。このパラメーターは、インスタンスのスペックアップまたはスペックダウンのリソースを評価する場合に必要です。

    dds-bp14bf67a76d****
    ReplicationFactor

    string

    任意

    インスタンス内のノード数。

    • スタンドアロンインスタンスの場合は、値を 1 に設定します。

    • 共有ストレージを使用するインスタンスの場合は、値を 2 に設定します。

    • レプリカセットインスタンスの場合、有効な値は 3、5、7 です。

    3
    ReadonlyReplicas

    string

    任意

    インスタンス内の読み取り専用ノードの数。有効な値：1～5。

    説明

    このパラメーターは、スタンドアロンインスタンスには必要ありません。

    1
    Storage

    string

    任意

    レプリカセットのストレージ容量。単位：GB。

    説明

    このパラメーターは、インスタンスがクラウドディスクを使用する場合に必要です。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    DBInstanceAvailable

    string

    現在のリージョンでリソースが利用可能かどうかを示します。有効な値：

    • 1：リソースは十分です。

    • 0：リソースは不足しています。

    1
    EngineVersion

    string

    データベースエンジンのバージョン。

    4.0
    RequestId

    string

    リクエスト ID。

    AE2DE465-E45F-481F-ABD8-37D64173****
    Engine

    string

    データベースエンジン。値は MongoDB に固定されています。

    MongoDB

    例

    成功レスポンス

    JSONJSON

    {
  "DBInstanceAvailable": "1",
  "EngineVersion": "4.0",
  "RequestId": "AE2DE465-E45F-481F-ABD8-37D64173****",
  "Engine": "MongoDB"
}

    エラーコード

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

    変更履歴

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