DescribeDBInstancePerformance - - Alibaba Cloud ドキュメントセンター

MongoDB インスタンスのパフォーマンスデータをクエリします。

今すぐお試しください

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

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

dds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。説明このパラメーターがシャードクラスターインスタンスの ID に設定されている場合、NodeId パラメーターも必須です。	dds-bp2635****
NodeId	string	任意	シャードクラスターインスタンス内の Mongos またはシャードノードの ID。このパラメーターを使用すると、単一ノードのパフォーマンスをクエリできます。説明このパラメーターは、DBInstanceId がシャードクラスターインスタンスの ID に設定されている場合にのみ使用できます。	d-bp2287****
Key	string	必須	パフォーマンスメトリック。詳細については、「メトリック」をご参照ください。説明複数のメトリックを指定するには、カンマ (,) で区切ります。	CpuUsage
StartTime	string	必須	クエリする時間範囲の開始時刻。時間は yyyy-MM-ddTHH:mmZ 形式で指定します。時間は UTC である必要があります。	2022-06-13T10:58Z
EndTime	string	必須	クエリする時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時間は yyyy-MM-ddTHH:mmZ 形式で指定します。時間は UTC である必要があります。	2022-06-13T11:58Z
RoleId	string	任意	スタンドアロンインスタンスまたはレプリカセットインスタンス内のノードのロール ID。ロール ID をクエリするには、DescribeReplicaSetRole 操作を呼び出します。説明このパラメーターは、DBInstanceId がスタンドアロンインスタンスまたはレプリカセットインスタンスの ID に設定されている場合にのみ使用できます。	6025****
Interval	string	任意	パフォーマンスメトリックのデータ粒度 (秒)。有効値：5、30、60、600、1800、3600、86400。	60
ReplicaSetRole	string	任意	スタンドアロンインスタンスまたはレプリカセットインスタンス内のノードのロール。有効値： Primary：プライマリノード。 Secondary：セカンダリノード。説明このパラメーターは、DBInstanceId がスタンドアロンインスタンスまたはレプリカセットインスタンスの ID に設定されている場合にのみ使用できます。 DBInstanceId がスタンドアロンインスタンスの ID に設定されている場合、このパラメーターは値 Primary のみをサポートします。	Primary
SearchId	string	任意	Search ノード ID。説明このパラメーターは、インスタンスで Search 機能が有効になった後にのみ使用できます。	dds-2zec12675c9e****-search

レスポンスフィールド

フィールド	型	説明	例
	object
PerformanceKeys	object
PerformanceKey	array<object>	パフォーマンスメトリックのリスト。
	array<object>
Key	string	パフォーマンスメトリック。	CpuUsage
Unit	string	パフォーマンスメトリックの単位。	%
ValueFormat	string	パフォーマンスメトリック値のフォーマット。パフォーマンスメトリックに複数のフィールドが含まれている場合、フィールドはアンパサンド (&) で区切られます。たとえば、ディスク領域の使用量をクエリした場合、返される ValueFormat は ins_size&data_size&log_size です。	cpu_usage
PerformanceValues	object
PerformanceValue	array<object>	パフォーマンスメトリック値のリスト。
	object
Value	string	パフォーマンスメトリックの値。	0.23
Date	string	パフォーマンスメトリック値が生成された時間。	2022-06-13T10:58:00Z
EndTime	string	クエリする時間範囲の終了時刻。時間は yyyy-MM-ddTHH:mmZ 形式です。時間は UTC で表示されます。	2022-06-13T11:58Z
RequestId	string	リクエスト ID。	4A300BC7-6D8F-527F-A2DB-A7768D26E9AC
StartTime	string	クエリする時間範囲の開始時刻。時間は yyyy-MM-ddTHH:mmZ 形式です。時間は UTC で表示されます。	2022-06-13T10:58Z

例

成功レスポンス

JSONJSON

{
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "Key": "CpuUsage",
        "Unit": "%",
        "ValueFormat": "cpu_usage",
        "PerformanceValues": {
          "PerformanceValue": [
            {
              "Value": "0.23",
              "Date": "2022-06-13T10:58:00Z"
            }
          ]
        }
      }
    ]
  },
  "EndTime": "2022-06-13T11:58Z",
  "RequestId": "4A300BC7-6D8F-527F-A2DB-A7768D26E9AC",
  "StartTime": "2022-06-13T10:58Z"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidPerformanceKey.Malformed	The specified parameter Key is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time

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

変更履歴

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