Classic/VPC環境で利用できます。
インスタンスの Extended Metric収集設定の状態を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET, POST | /cw_fea/real/cw/api/schema/extended/status |
参考
GET方式は今後サポート対象から除外される予定ですので、POST方式の使用をお勧めします。
リクエストヘッダ
Cloud Insight APIで共通して使用されるヘッダの詳細は、Cloud Insightのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
GET方式で呼び出す場合、リクエストクエリパラメータが必要です。リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
cw_key |
String | Required | 商品キー(cw_key) |
instanceIds |
String | Required | インスタンス ID |
リクエストボディ
POST方式で呼び出す場合、リクエストボディが必要です。リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
prodKey |
String | Required | 商品キー(cw_key) |
servers |
Array | Required | インスタンス IDリスト |
リクエスト例
リクエストのサンプルコードは次の通りです。
GET方式で呼び出した場合
GET方式で呼び出した場合のリクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/schema/extended/status?cw_key=**********&instanceIds=**********' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
POST方式で呼び出した場合
POST方式で呼び出した場合のリクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/schema/extended/status' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"prodKey": "**********",
"servers": ["**********", "**********"]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
enabled |
Boolean | - | Extended Metric収集設定の有無
|
instanceId |
String | - | インスタンス ID |
レスポンスステータスコード
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Cloud Insight APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
[
{
"enabled": false,
"instanceId": "**********"
}
]