GetExtendedStatus
    • PDF

    GetExtendedStatus

    • PDF

    Article summary

    Available in Classic and VPC

    Get the collection configuration status of extended metrics for the instance.

    Request

    This section describes the request format. The method and URI are as follows:

    MethodURI
    GET, POST/cw_fea/real/cw/api/schema/extended/status
    Note

    GET method is scheduled to be excluded from support in the future, so we recommend using the POST method.

    Request headers

    For information about the headers common to all Cloud Insight APIs, see Cloud Insight request headers.

    Request query parameters

    When calling with the GET method, a request query parameter is required. You can use the following query parameters with your request:

    FieldTypeRequiredDescription
    cw_keyStringRequiredProduct key (cw_key)
    instanceIdsStringRequiredInstance ID

    Request body

    When calling with the POST method, a request body is required. You can include the following data in the body of your request:

    FieldTypeRequiredDescription
    prodKeyStringRequiredProduct key (cw_key)
    serversArrayRequiredInstance ID list

    Request example

    The request example is as follows:

    When called by GET method

    The following is a sample request when called using the GET method.

    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}'
    

    When called by POST method

    The following is a sample request when called using the POST method.

    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": ["**********", "**********"]
    }'
    

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    enabledBoolean-Whether collection of extended metrics is enabled
    • true | false
      • true: enabled
      • false: disabled
    instanceIdString-Instance ID

    Response status codes

    For response status codes common to NAVER Cloud Platform, see Cloud Insight API response status codes.

    Response example

    The response example is as follows:

    [
        {
            "enabled": false,
            "instanceId": "**********"
        }
    ]
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.