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

Return to the regular view of this page.

CreateCustomMetricMetas

1: 1.4
2: 1.3
3: 1.2
4: 1.1

1 - 1.4

post /v1/metrics/custom/meta

Description

Create Custom Metric Metas

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricCustomMetaRequest

Responses

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

Example HTTP request

Request path

/v1/metrics/custom/meta

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.4"

Request body

{
    "metricMetas": [
        {
            "descriptionEn": "filestorage volume total byte",
            "descriptionKo": "파일스토리지 총 바이트 수",
            "dimensions": [
                [
                    "image_id"
                ]
            ],
            "metricName": "Custom_filestorage_volume_total_byte",
            "storageResolution": 60,
            "unit": "Bytes"
        }
    ],
    "namespace": "MyCustom/filestorage"
}

Example HTTP response

Response 200

{
    "account_id": "d79a5194b1a44a858969eb94754d3ba1",
    "max_data_points": "",
    "unit_logs": [
        {
            "code": "Success",
            "message": "[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes"
        }
    ]
}

2 - 1.3

post /v1/metrics/custom/meta

Description

Create Custom Metric Metas

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20270131

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricCustomMetaRequest

Responses

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

Example HTTP request

Request path

/v1/metrics/custom/meta

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.3"

Request body

{
    "metricMetas": [
        {
            "descriptionEn": "filestorage volume total byte",
            "descriptionKo": "파일스토리지 총 바이트 수",
            "dimensions": [
                [
                    "image_id"
                ]
            ],
            "metricName": "Custom_filestorage_volume_total_byte",
            "storageResolution": 60,
            "unit": "Bytes"
        }
    ],
    "namespace": "MyCustom/filestorage"
}

Example HTTP response

Response 200

{
    "account_id": "d79a5194b1a44a858969eb94754d3ba1",
    "max_data_points": "",
    "unit_logs": [
        {
            "code": "Success",
            "message": "[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes"
        }
    ]
}

3 - 1.2

post /v1/metrics/custom/meta

Description

Create Custom Metric Metas

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricCustomMetaRequest

Responses

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

Example HTTP request

Request path

/v1/metrics/custom/meta

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

{
    "metricMetas": [
        {
            "descriptionEn": "filestorage volume total byte",
            "descriptionKo": "파일스토리지 총 바이트 수",
            "dimensions": [
                [
                    "image_id"
                ]
            ],
            "metricName": "Custom_filestorage_volume_total_byte",
            "storageResolution": 60,
            "unit": "Bytes"
        }
    ],
    "namespace": "MyCustom/filestorage"
}

Example HTTP response

Response 200

{
    "account_id": "d79a5194b1a44a858969eb94754d3ba1",
    "max_data_points": "",
    "unit_logs": [
        {
            "code": "Success",
            "message": "[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes"
        }
    ]
}

4 - 1.1

post /v1/metrics/custom/meta

Description

Create Custom Metric Metas

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.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricCustomMetaRequest

Responses

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

Example HTTP request

Request path

/v1/metrics/custom/meta

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

{
    "metricMetas": [
        {
            "descriptionEn": "filestorage volume total byte",
            "descriptionKo": "파일스토리지 총 바이트 수",
            "dimensions": [
                [
                    "image_id"
                ]
            ],
            "metricName": "Custom_filestorage_volume_total_byte",
            "storageResolution": 60,
            "unit": "Bytes"
        }
    ],
    "namespace": "MyCustom/filestorage"
}

Example HTTP response

Response 200

{
    "account_id": "d79a5194b1a44a858969eb94754d3ba1",
    "max_data_points": "",
    "unit_logs": [
        {
            "code": "Success",
            "message": "[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes"
        }
    ]
}