GetUsage
Gets the usage data of a usage plan in a specified time interval.
Request Syntax
GET /usageplans/usageplanId/usage?endDate=endDate&keyId=keyId&limit=limit&position=position&startDate=startDate HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- endDate
-
The ending date (e.g., 2016-12-31) of the usage data.
Required: Yes
- keyId
-
The Id of the API key associated with the resultant usage data.
- limit
-
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
The current pagination position in the paged result set.
- startDate
-
The starting date (e.g., 2016-01-01) of the usage data.
Required: Yes
- usageplanId
-
The Id of the usage plan associated with the usage data.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"endDate": "string",
"values": {
"string" : [
[ number ]
]
},
"position": "string",
"startDate": "string",
"usagePlanId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- endDate
-
The ending date of the usage data.
Type: String
- values
-
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,
{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where{api_key}stands for an API key ID and the daily log entry is of the format[used quota, remaining quota].Type: String to array of arrays of longs map
- position
-
The current pagination position in the paged result set.
Type: String
- startDate
-
The starting date of the usage data.
Type: String
- usagePlanId
-
The plan Id associated with this usage data.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
- NotFoundException
-
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
- TooManyRequestsException
-
The request has reached its throttling limit. Retry after the specified time period.
HTTP Status Code: 429
- UnauthorizedException
-
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
Examples
Get usage data
This example illustrates one usage of GetUsage.
Sample Request
GET /usageplans/q2hrol/usage?startDate=2016-08-01&endDate=2016-08-04 HTTP/1.1
Content-Type: application/json
Host: apigateway.ap-southeast-1.amazonaws.com
Content-Length: 254
X-Amz-Date: 20160801T211516Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160801/ap-southeast-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigv4_hash}
Sample Response
{
"_links": {
"self": {
"href": "/usageplans/q2hrol/usage?startDate=2016-08-01&endDate=2016-08-04"
},
"first": {
"href": "/usageplans/q2hrol/usage?startDate=2016-08-01&endDate=2016-08-04"
}
},
"endDate": "2016-08-04",
"startDate": "2016-08-01",
"usagePlanId": "q2hrol",
"values": {
"px1KW6TIqK6L8PfqZYR3R3rrFWSS74BB5qBazOJH6": [
[
0,
5000
],
[
0,
5000
],
[
0,
10
],
[
0,
10
]
]
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
