注意
このAPIは廃止されました。関連情報の照会については、DescribeMetricsData - 監視メトリックデータの照会をご参照ください。
機能説明
このAPIは、OceanBaseノードのメトリック情報を照会するために使用されます。
呼び出し説明
API制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/nodes/{nodeId}/metrics
リクエストパラメータ
パスパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudクラウドデータベースインスタンスID。 | ob317v4uif**** |
| nodeId | string | はい | ノードID。 | i-bp16niirq4zdmgvm** |
Queryパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
Bodyパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| startTime | string | はい | 監視データの開始時間です。この時間はUTC時刻のみをサポートし、形式はYYYY-MM-DDThh:mm:ssZです。 | 2021-06-13T15:40:43Z |
| endTime | string | はい | モニタリングデータの終了時刻です。この時間はUTC時間のみをサポートし、形式はYYYY-MM-DDThh:mm:ssZです。 | 2021-09-13T15:40:43Z |
| metrics | array[string] | はい | 指標名のリストです。 | ["total_sessions_tenant"] |
| tenantIdList | array[string] | いいえ | テナントIDのリストです。 | ["t4tx6u5tc****"] |
| nodeIdList | array[string] | いいえ | ノードIDのリストです。 | ["i-0104c6fb57e6e****"] |
| UID | string | いいえ | ユーザーIDです。 | なし |
| User_ID | string | いいえ | ユーザーIDです。 | なし |
| requestId | string | いいえ | リクエストIDです。 | なし |
| callerType | string | いいえ | 呼び出し元のタイプです。 | なし |
| accessKeyId | string | いいえ | アクセスキーIDです。 | なし |
| securityToken | string | いいえ | セキュリティトークンです。 | なし |
| callerUid | string | いいえ | 呼び出し元のUIDです。 | なし |
| callerBid | string | いいえ | 呼び出し元のBIDです。 | なし |
| stsTokenCallerUid | string | いいえ | STSトークン呼び出し元のUIDです。 | なし |
| stsTokenCallerBid | string | いいえ | STSトークン呼び出し元のBIDです。 | なし |
| acceptLanguage | string | いいえ | 対応言語です。 | なし |
| pageNumber | integer | いいえ | ページ番号です。 | 1 |
| pageSize | integer | いいえ | 1ページあたりの表示数です。 | 10 |
| mergedCallerBid | string | いいえ | メジャーコンパクションされた呼び出し元のBIDです。 | なし |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| RequestId | string | リクエストIDです。 | EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C |
| data | List | ノードメトリック情報です。 | 下記コード例を参照 |
data の例：
"data":[
{
"nodeId":"ins-122dhae",
"ip":"xx.xxx.xxx.xx",
"obInstanceId":"xx.xx.xxx.xxx",
"metrics":[
{
"total_sessions_tenant":0,
"timestamp":1687640160
},
{
"total_sessions_tenant":1,
"timestamp":1687661700
},
{
"total_sessions_tenant":1,
"timestamp":1687661760
}
]
}
]
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/nodes/{nodeId}/metrics?requestId={requestId}' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{
"startTime": "2021-06-13T15:40:43Z",
"endTime": "2021-09-13T15:40:43Z",
"metrics": ["total_sessions_tenant"],
"tenantIdList": ["t4tx6u5tc****"],
"nodeIdList": ["i-0104c6fb57e6e****"]
}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。クラスタのプロジェクトIDについては、プロジェクト管理をご参照ください。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
戻り値の例
JSON形式：
{
"RequestId": "EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C",
"data":[
{
"nodeId":"ins-122dhae",
"ip":"xx.xxx.xxx.xx",
"obInstanceId":"xx.xx.xxx.xxx",
"metrics":[
{
"total_sessions_tenant":0,
"timestamp":1687640160
},
{
"total_sessions_tenant":1,
"timestamp":1687661700
},
{
"total_sessions_tenant":1,
"timestamp":1687661760
}
]
}
]
}