Updated on 2022-02-22 GMT+08:00

Querying the Instance Name and Status

Function Description

This API is used to query the name and status of the instance for interconnecting with Cloud Eye.

URI

  • URI format

    GET /v1/{project_id}/waf/instance/{instance_id}/metrics

  • Parameter description
    Table 1 Path parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Specifies the project ID.

    instance_id

    Yes

    String

    Specifies the instance ID.

Request

Request parameters

None

Response

Response parameters

Table 2 Parameter description

Parameter

Type

Description

waf_instance_id

String

Specifies the identifier of a metric dimension.

name

String

Specifies the name of a resource instance.

status

String

Specifies the status of a resource instance.

Example

Response example

{
     "waf_instance_id": "dhbvhdfbvdhbasdkjvfhwoow",
     "name": "www.test.com",
     "status": "enable"
}

Status Code

Table 3 describes the normal status code returned by the API.
Table 3 Status code

Status Code

Description

Meaning

200

OK

The request has succeeded.

For details about error status codes, see Status Codes.