Updated on 2025-05-29 GMT+08:00

Querying Server Performance Data

Function

Query server performance data.

SLA Item

Definition

Request success rate

≥ 99.9%

Availability

Tier 1

Data consistency

Eventual consistency can be achieved. The duration of inconsistency is less than 1 minute.

Throughput

4000 TPS

TP50 request latency

2 ms

TP99.9 request latency

5 ms

Precautions

None

Calling Method

GET

URI

/rest/dataapi/homs/open-api/v1/host/performancedata

Path parameters

None

Query parameters

Parameter

Mandatory

Type

Value Range

Description

sn

No

string

None

Host SN UUID

begin_time

Yes

long

Millisecond timestamp

Start time

end_time

Yes

long

Millisecond timestamp

End time

offset_value

No

integer

None

Offset: greater than or equal to 0

page_size

No

integer

0~1000

Page size: greater than or equal to 0

Request

  • Request header parameters

    Parameter

    Mandatory

    Type

    Value Range

    Description

    X-APIG-Appcode

    Yes

    string

    None

    AppCode allocated by SRE

    x-auth-token

    Yes

    string

    None

    IAM authentication token for the calling party APIG

    x-hcso-domainid

    No

    string

    None

    ID of the accessed tenant. This parameter is mandatory only in the HCS Online scenario.

    x-hcso-appcode

    Yes

    string

    None

    AppCode allocated by SRE

  • Request body parameters

    None

  • Sample request
    GET /rest/dataapi/homs/open-api/v1/host/performancedata HTTP/1.1 
    Host: example.com 
    Content-Type: application/json 
    Accept: application/json
    X-APIG-Appcode: xxx 
    x-auth-token: xxx 
    x-hcso-domainid: xxx
    x-hcso-appcode: xxx

Response

  • Response parameters
  • Sample response
    HTTP/1.1 200 OK
    Date:Tue,18 Jul 2023 09:58:01 GMT
    Server: example.com
    Content-Type: application/json;charset=UTF8
    {
         "total": 5,
         "list": [
                  {
                  "dc_code": "WC_WUH_18",
                  "az_code": "cn-north-7",
                  "usage": "mgt|mgt-can",
                  "room_code": "wuhd22",
                  "dates": "2024-01-08",
                  "metric": "CPUUsagePercent",
                  "pack_code": "wuhd22-c-01-7",
                  "model": "2288X V5",
                  "time": "2024-01-08 0:00",
                  "sn": "xxx",
                  "value": "38",
                  "region_code": "cn-north-7",
                  "slot_number": "4"
                   }
                 ]
       }

Status Codes

Status Code

Description

200

Operation successful.

400

Parameter error.

401

Token authentication failed.

403

Authentication failed.

404

The API was not found.

Operation Severity

Minor