DescribeInstancePackets - API Gateway - Alibaba Cloud Documentation Center

Queries the numbers of inbound and outbound packets of a dedicated instance within a period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ	2022-05-18T01:14:26Z
EndTime	string	Yes	The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ	2022-05-24T10:14:53Z
InstanceId	string	Yes	The ID of the instance.	apigateway-cn-2r426lavr001
SbcName	string	Yes	The statistical metric. Valid values: Maximum Minimum Average	Maximum

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
InstancePackets	object []	The list of inbound and outbound data packets in the instance.
ItemValue	string	The number of inbound and outbound data packets in the instance.	0
ItemTime	string	The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ	2022-05-24T10:14:53Z
Item	string	The metric. Valid values: InstancePacketRX: inbound data packets InstancePacketTX: outbound data packets	InstancePacketRX

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "InstancePackets": {
    "MonitorItem": [
      {
        "ItemValue": "0",
        "ItemTime": "2022-05-24T10:14:53Z\n",
        "Item": "InstancePacketRX"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history