All Products
Search
Document Center

API Gateway:DescribeInstancePackets

Last Updated:Nov 24, 2023

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

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.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimestringYes

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
EndTimestringYes

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
InstanceIdstringYes

The ID of the instance.

apigateway-cn-2r426lavr001
SbcNamestringYes

The statistical metric. Valid values:

  • Maximum
  • Minimum
  • Average
Maximum

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
InstancePacketsobject []

The list of inbound and outbound data packets in the instance.

ItemValuestring

The number of inbound and outbound data packets in the instance.

0
ItemTimestring

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
Itemstring

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 timeSummary of changesOperation
No change history