この API は、MongoDB インスタンスのパフォーマンスデータをクエリする場合に呼び出すことができます。

デバッグ

OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。

リクエストパラメータ

パラメータ データ型 必須 例 説明
Action String はい DescribeDBInstancePerformance

実行する操作。 値を DescribeDBInstancePerformance に設定します。

Key String はい MongoDB_DetailedSpaceUsage

パフォーマンス指標。 有効値の詳細は、 パフォーマンスパラメータ をご参照ください。

注 複数のインジケーターはコンマ（、）で区切ります。
StartTime String はい 2019-03-11T12:30Z

クエリの開始時刻。 時刻形式：yyyy-MM-ddTHH:mmZ。

EndTime String はい 2019-03-11T12:30Z

クエリの終了時刻。 時刻形式：yyyy-MM-ddTHH:mmZ。

DBInstanceId String はい dds-bpxxxxxxxx

インスタンスの ID

注 このパラメーターをシャードクラスターインスタンスの ID に指定する場合は、 NodeId パラメータを指定する必要があります。
NodeId String いいえ d-bpxxxxxxxx

シャードクラスターインスタンス内の mongos または Shard の ID。 このパラメーターを指定して、単一ノードのパフォーマンスをクエリできます。

注 このパラメーターは、シャードクラスターインスタンスの ID に DBInstanceId パラメーターを指定した場合にのみ有効です。
RoleId String いいえ 60xxxxx

インスタンス内のノードのロール ID。 DescribeReplicaSetRole を呼び出して、ロール ID をクエリできます。

注 このパラメーターは、DBInstanceId パラメーターをスタンドアロンインスタンスまたはレプリカセットインスタンスの ID に指定した場合にのみ有効です。
ReplicaSetRole String いいえ Primary

レプリカセットインスタンス内のノードのロール。 有効値：

  • Primary
  • Secondary
注 このパラメーターは、DBInstanceId パラメーターをスタンドアロンインスタンスまたはレプリカセットインスタンスの ID に指定した場合にのみ有効です。
AccessKeyId String いいえ LTAIgbTGpxxxxxx

Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメータ

パラメータ タイプ 例 説明
RequestId String 267F98DC-367D-4F20-B137-8B5B664D1C5D

リクエストの ID です。

StartTime String 2019-03-11T12:20Z

クエリの開始時刻。 時刻形式：yyyy-MM-ddTHH:mmZ。

EndTime String 2019-03-11T12：30Z

クエリの終了時刻。 時刻形式：yyyy-MM-ddTHH:mmZ。

PerformanceKeys

パフォーマンスインジケータ情報のリスト。

└Key String MongoDB_DetailedSpaceUsage

パフォーマンス指標。

└PerformanceValues

パフォーマンス指標の値のリスト。

└Date String 2019-03-11T12:21:51Z

値が生成される日時。

└Value String 0.6

パフォーマンスインジケーターの値。

└Unit String MB

インジケータ値の単位。

└ValueFormat String cpu_usage

パフォーマンスインジケータ値の形式。 パフォーマンスインジケータに複数のフィールドが含まれる場合、フィールドはアンパサンド（＆）で区切られます。

たとえば、ディスク容量の使用状況をクエリすると、ValueFormatはins_size＆data_size＆log_size が返されます。

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=DescribeDBInstancePerformance
&Key=MongoDB_DetailedSpaceUsage
&StartTime=2019-03-11T12:30Z
&EndTime=2019-03-11T12:30Z
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

通常のレスポンスの例

XML 形式 

<DescribeDBInstancePerformanceResponse>
  <RequestId>267F98DC-367D-4F20-B137-8B5B664D1C5D</RequestId>
  <PerformanceKeys>
    <PerformanceKey>
      <Key>MongoDB_DetailedSpaceUsage</Key>
      <PerformanceValues>
        <PerformanceValue>
          <Value>1768&amp;1282&amp;486</Value>
          <Date>2019-03-11T12:21:51Z</Date>
        </PerformanceValue>
        <PerformanceValue>
          <Value>1768&amp;1282&amp;486</Value>
          <Date>2019-03-11T12:26:52Z</Date>
        </PerformanceValue>
      </PerformanceValues>
      <Unit>MB</Unit>
      <ValueFormat>ins_size&amp;data_size&amp;log_size</ValueFormat>
    </PerformanceKey>
  </PerformanceKeys>
  <EndTime>2019-03-11T12:30Z</EndTime>
  <StartTime>2019-03-11T12:20Z</StartTime>
</DescribeDBInstancePerformanceResponse>

JSON 形式 

{
	"RequestId":"267F98DC-367D-4F20-B137-8B5B664D1C5D",
	"PerformanceKeys":{
		"PerformanceKey":[
			{
				"Key":"MongoDB_DetailedSpaceUsage",
				"PerformanceValues":{
					"PerformanceValue":[
						{
							"Value":"1768&1282&486",
							"Date":"2019-03-11T12:21:51Z"
						},
						{
							"Value":"1768&1282&486",
							"Date":"2019-03-11T12:26:52Z"
						}
					]
				},
				"Unit":"MB",
				"ValueFormat":"ins_size&data_size&log_size"
			}
		]
	},
	"EndTime":"2019-03-11T12:30Z",
	"StartTime":"2019-03-11T12:20Z"
}

エラーコード

エラーコードの表示