This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

ListMetricData

1: 1.2
2: 1.1
3: 1.0

1 - 1.2

post /v1/metrics/data

Description

Get metric data list

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MetricDataResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "end": 1640995440,
    "metrics": [
        {
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG"
}

Example HTTP response

Response 200

{
    "metrics": [
        {
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "status": "",
            "values": "[[1640995200, \"45.5\"]]"
        }
    ]
}

2 - 1.1

post /v1/metrics/data

Description

Get metric data list

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MetricDataResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "end": 1640995440,
    "metrics": [
        {
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG"
}

Example HTTP response

Response 200

{
    "metrics": [
        {
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "status": "",
            "values": "[[1640995200, \"45.5\"]]"
        }
    ]
}

3 - 1.0

post /v1/metrics/data

Description

Get metric data list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataRequest

Responses

HTTP Code	Description	Schema
200	OK	MetricDataResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "end": 1640995440,
    "metrics": [
        {
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "individual_items": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG"
}

Example HTTP response

Response 200

{
    "metrics": [
        {
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "status": "",
            "values": "[[1640995200, \"45.5\"]]"
        }
    ]
}