All Products
Search
Document Center

API Gateway:DescribeInstancePackets

Last Updated:Sep 25, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeInstancePacketsget
  • Instance
    acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

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
InstancePacketsarray<object>

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

MonitorItemobject
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