Querying Server Configuration Data

Function

This API is used to query the server configuration for a specified event type in a specified time range. You can specify the dimension of data to be queried. This API is provided for SAP Monitor in the HANA scenario to query the server configuration. In other scenarios, the server configuration cannot be queried with this API.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

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

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ces:eventData:get

Read

-

-

ces:sapEventData:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ces:eventData:get	Read	-	-	ces:sapEventData:list	-

URI

GET /V1.0/{project_id}/event-data

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
namespace	Yes	String	Definition Service namespace, for example, the namespace of ECS is SYS.ECS . For details about service namespaces, see Services Interconnected with Cloud Eye. Constraints N/A Range The value is in the format of service.item, where service and item are separated by a period (.). service and item each must start with a letter. They can contain letters, digits, and underscores (_) and allow 3 to 32 characters. Default Value N/A
dim.0	Yes	String	Definition First-level dimension of a metric. A maximum of four dimensions are supported. The dimension format is dim.{i}=key,value. A key,value example is instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d . For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Constraints N/A Range Format: dim.0=key,value. key and value are separated by a comma (,). key must start with a letter. It can contain letters, digits, underscores (), and hyphens (-) and allows 1 to 32 characters. value* can contain letters, digits, underscores (), hyphens (-), periods (.), slashes (/), number signs (#), and parentheses. It cannot start with a hyphen (-) but can start with an asterisk () or other allowed characters. It allows 1 to 256 characters. Default Value N/A
dim.1	No	String	Definition Second-level dimension of a metric. A maximum of four dimensions are supported. The dimension format is dim.{i}=key,value. A key,value example is instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d . For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Constraints N/A Range Format: dim.1=key,value. key and value are separated by a comma (,). key must start with a letter. It can contain letters, digits, underscores (), and hyphens (-) and allows 1 to 32 characters. value* can contain letters, digits, underscores (), hyphens (-), periods (.), slashes (/), number signs (#), and parentheses. It cannot start with a hyphen (-) but can start with an asterisk () or other allowed characters. It allows 1 to 256 characters. Default Value N/A
dim.2	No	String	Definition Third-level dimension of a metric. A maximum of four dimensions are supported. The dimension format is dim.{i}=key,value. A key,value example is instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d . For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Constraints N/A Range Format: dim.2=key,value. key and value are separated by a comma (,). key must start with a letter. It can contain letters, digits, underscores (), and hyphens (-) and allows 1 to 32 characters. value* can contain letters, digits, underscores (), hyphens (-), periods (.), slashes (/), number signs (#), and parentheses. It cannot start with a hyphen (-) but can start with an asterisk () or other allowed characters. It allows 1 to 256 characters. Default Value N/A
dim.3	No	String	Definition Fourth-level dimension of a metric. A maximum of four dimensions are supported. The dimension format is dim.{i}=key,value. A key,value example is instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d . For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Constraints N/A Range Format: dim.3=key,value. key and value are separated by a comma (,). key must start with a letter. It can contain letters, digits, underscores (), and hyphens (-) and allows 1 to 32 characters. value* can contain letters, digits, underscores (), hyphens (-), periods (.), slashes (/), number signs (#), and parentheses. It cannot start with a hyphen (-) but can start with an asterisk () or other allowed characters. It allows 1 to 256 characters. Default Value N/A
type	Yes	String	Definition Event type. Constraints N/A Range The value must start with a letter. It can contain letters, digits, underscores (_), and hyphens (-) and allows 1 to 64 characters. Default Value N/A
from	Yes	Long	Definition Start time of the query. The value is a UNIX timestamp in milliseconds. Constraints N/A Range The millisecond-level timestamp range is [0,9999999999999]. Default Value N/A
to	Yes	Long	Definition End time of the query. The value is a UNIX timestamp in milliseconds. Constraints The value of from must be earlier than that of to. Range The millisecond-level timestamp range is [0,9999999999999]. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Definition MIME type of the request body. Constraints N/A Range 1 to 64 characters Default Value Default value application/json; charset=UTF-8 is recommended. For APIs used to upload objects or images, the MIME type varies with the flow type.
X-Auth-Token	No	String	Definition User token. Constraints N/A Range 1 to 16,384 characters Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
datapoints	Array of EventDataInfo objects	Definition Configuration information list. Range N/A

**Table 5** EventDataInfo
Parameter	Type	Description
type	String	Definition Event type. Range N/A
timestamp	Long	Definition Time when the event was reported. The value is a UNIX timestamp, in milliseconds. Range N/A
value	String	Definition Server configuration information. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
-	String	Request error.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
-	String	The authentication information is not provided or is incorrect.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
-	String	Access to the requested page is forbidden.

Status code: 408

**Table 9** Response body parameters
Parameter	Type	Description
-	String	The request timed out.

Status code: 429

**Table 10** Response body parameters
Parameter	Type	Description
-	String	Too many requests.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
-	String	Failed to complete the request because of an internal service error.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
-	String	The system is currently unavailable.

Example Requests

/V1.0/{project_id}/event-data?namespace=SYS.ECS&dim.0=instance_id,33328f02-3814-422e-b688-bfdba93d4051&type=instance_host_info&from=1450234543422&to=1450320943422

Example Responses

Status code: 200

{
  "datapoints" : [ {
    "type" : "instance_host_info",
    "timestamp" : 1450231200000,
    "value" : "20"
  }, {
    "type" : "instance_host_info",
    "timestamp" : 1450231800000,
    "value" : "30"
  } ]
}