Querying the Reported Information List

Function

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v3/{project_id}/csemonitor/metric/list

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which must be unique. The value contains 1 to 64 characters.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
page	No	String	Page number.
number	No	String	Page size.
sortType	No	String	Sorting type. Enumerated values: increase decrease
sortKey	No	String	Sorting field. Enumerated values: name qps latency total
appIds	No	String	List of applications to be queried, which are separated by commas (,).
nameFilter	No	String	Filter name.

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Enterprise-Project-ID	No	String	If this parameter is not set, the default enterprise project is default and the ID is 0.
Content-Type	Yes	String	Set it to application/json;charset=UTF-8.
Accept	Yes	String	Set it to application/json.

Response

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
list	Array of KeyObject	Key list.
appIds	Array of String	Application ID list.
page	Integer	Page number.
number	Integer	Number of records on the current page.
total	Integer	Total number of queries.

**Table 5** KeyObject
Parameter	Type	Description
key	String	Key.
serviceId	String	Service ID.
serviceName	String	Service name.
appId	String	Application ID.
version	String	Version.
environment	String	Environment name.
custom	Map object	Custom information.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Example Request

GET https://{endpoint}/v3/{project_id}/csemonitor/metric/list

Example Response

Status code: 200

{
  "list": [
    {
      "key": "string",
      "serviceId": "string",
      "appId": "string",
      "version": "string",
      "environment": "string",
      "custom": {
        "key": 1.0
      }
    }
  ],
  "appIds": ["string", "string"],
  "page": 0,
  "number": 0,
  "total": 0
}