DescribeNodeMetrics - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the detailed metrics information of an OceanBase Database node.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The list of nodes.	ob317v4uif****
PageSize	integer	No	The ID of the tenant.	10
PageNumber	integer	No	$.parameters[6].schema.description	1
TenantId	string	No	$.parameters[6].schema.enumValueTitles	tfafd34fs****
StartTime	string	Yes	$.parameters[9].schema.example	2021-06-13T15:40:43Z
EndTime	string	Yes	$.parameters[7].schema.description	2021-09-13T15:40:43Z
Metrics	string	Yes	$.parameters[7].schema.enumValueTitles	tps
NodeName	string	No	$.parameters[8].schema.example	i-bp16niirq4zdmgvm****
NodeIdList	string	No	$.parameters[10].schema.description	[i-bp16niirq4zdmgvm**,i-bp16n56hq4z4fgvm**]

Response parameters

Parameter Type Description Example

Parameter	Type	Description	Example
	object	$.parameters[10].schema.enumValueTitles
TotalCount	integer	`http(s)://[Endpoint]/?Action=DescribeNodeMetrics &InstanceId=ob317v4uif** &PageSize=10 &PageNumber=1 &TenantId=ob2mr3oae0 &StartTime=2021-06-13 15:40:43 &EndTime=2021-09-13 15:40:43 &Metrics=tps &NodeName=i-bp16niirq4zdmgvm** &NodeIdList=["i-bp19y05uq6xpacyqnlrc","i-bp1blcr3htr3g3u2vqvu","i-bp1392ikhayhr3hi4fli"] &Common request parameters`	9
RequestId	string	You can call this operation to query the detailed metrics information of an OceanBase Database node.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

object

$.parameters[10].schema.enumValueTitles

TotalCount

integer

http(s)://[Endpoint]/?Action=DescribeNodeMetrics
&InstanceId=ob317v4uif****
&PageSize=10
&PageNumber=1
&TenantId=ob2mr3oae0****
&StartTime=2021-06-13 15:40:43
&EndTime=2021-09-13 15:40:43
&Metrics=tps
&NodeName=i-bp16niirq4zdmgvm****
&NodeIdList=["i-bp19y05uq6xpacyqnlrc","i-bp1blcr3htr3g3u2vqvu","i-bp1392ikhayhr3hi4fli"]
&Common request parameters

RequestId

string

You can call this operation to query the detailed metrics information of an OceanBase Database node.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Examples

Sample success responses

JSONformat

{
  "TotalCount": 9,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "NodeMetrics": "-"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-01-17	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-01-17	The request parameters of the API has changed	View Change Details