チェックカテゴリチェックのリクエスト

Prev Next

VPC環境で利用できます。

チェックカテゴリの全チェック項目に対するチェックをリクエストします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/categories/{categoryCode}/checkitems/refresh

リクエストヘッダ

Cloud Advisor APIで共通して使用されるヘッダの詳細は、Cloud Advisorのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
categoryCode String Required チェックカテゴリコード
  • SECURITY | COST
    • SECURITY: セキュリティカテゴリ
    • COST: コスト&高可用性カテゴリ

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/{categoryCode}/checkitems/refresh' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
 }'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
result String - API処理結果
  • SUCCESS | FAIL
    • SUCCESS: 成功
    • FAIL: 失敗
contents Array - チェック項目リスト
error Object - エラーコードとメッセージ
  • resultがFAILの場合に表示
error.errorCode String - エラーコード
error.message String - エラーメッセージ

チェック項目

チェック項目の詳細は次の通りです。

フィールド タイプ 必須の有無 説明
itemCode String - チェック項目コード
timeToRefresh Long - 次のチェック可能日時
  • Unix Timestamp形式
lastRequestTime Long - 最終チェック日時
  • Unix Timestamp形式
status String - チェックの状態
  • NONE | ENQUEUED | PROCESSING | DONE | FAIL
    • NONE: チェックリクエスト可能
    • ENQUEUED: チェック待機中
    • PROCESSING: チェック進行中
    • DONE: チェックリクエスト完了。次のリクエストまで待機
    • FAIL: チェックリクエスト失敗
requestSuccess String - チェックリクエストは成功したかどうか
  • true | false
    • true: 成功
    • false: 失敗

レスポンスステータスコード

Cloud Advisor APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Advisorのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "result": "SUCCESS",
    "contents": [
        {
            "itemCode": "CLOVA_OCR_UNUSED_RESOURCES",
            "timeToRefresh": 1744037730178,
            "lastRequestTime": 1743951330178,
            "status": "DONE",
            "requestSuccess": true
        },
        {
            "itemCode": "CLOVA_DUBBING_UNUSED_RESOURCES",
            "timeToRefresh": 1744037730363,
            "lastRequestTime": 1743951330363,
            "status": "DONE",
            "requestSuccess": true
        },
        {
            "itemCode": "IDLE_RESOURCE_VM",
            "timeToRefresh": 1744037730337,
            "lastRequestTime": 1743951330337,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "IDLE_RESOURCE_LB",
            "timeToRefresh": 1744037730259,
            "lastRequestTime": 1743951330259,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "HIGH_UTILIZATION_VM",
            "timeToRefresh": 1744037730298,
            "lastRequestTime": 1743951330298,
            "status": "DONE",
            "requestSuccess": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MYSQL",
            "timeToRefresh": 1744037730626,
            "lastRequestTime": 1743951330626,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "HIGH_UTILIZATION_REDIS",
            "timeToRefresh": 1744037730309,
            "lastRequestTime": 1743951330309,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "HIGH_UTILIZATION_MSSQL",
            "timeToRefresh": 1744037730229,
            "lastRequestTime": 1743951330229,
            "status": "DONE",
            "requestSuccess": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MONGO",
            "timeToRefresh": 1744037730280,
            "lastRequestTime": 1743951330280,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "OBJECT_STORAGE_MULTIPART",
            "timeToRefresh": 1743972930659,
            "lastRequestTime": 1743951330659,
            "status": "DONE",
            "requestSuccess": true
        }
    ]
}