DescribeApiHistories - API Gateway - Alibaba Cloud Documentation Center

Queries the historical versions of a specified API.

Operation description

This operation is intended for API providers. Only APIs that have been published have historical version records.
This operation allows you to obtain the historical versions of an API. This operation is always called by other operations.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeApiHistories	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the API group.	1084f9034c744137901057206b39d2b6
StageName	string	No	The name of the runtime environment. Valid values: RELEASE TEST	RELEASE
ApiId	string	No	The ID of the API.	c076144d7878437b8f82fb85890ce6a0
ApiName	string	No	The name of the API. The name is used for fuzzy match.	weather
PageSize	string	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
PageNumber	string	No	The number of the page to return. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	3
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ003
PageSize	integer	The number of entries returned per page.	15
TotalCount	integer	The total number of returned entries.	32
ApiHisItems	object []	The returned API information. It is an array consisting of ApiHisItem data.
Status	string	Indicates whether an API version is effective. Valid values: ONLINE and OFFLINE.	ONLINE
ApiId	string	The ID of the API.	5af418828f0344a3b588c0cc1331a3bc
Description	string	The description of the API.	Creates an object
GroupName	string	The name of the API group.	myGroup2
GroupId	string	The ID of the API group.	1084f9034c744137901057206b39d2b6
DeployedTime	string	The publishing time (UTC) of the API.	2016-07-20T08:28:48Z
StageName	string	The name of the runtime environment. Valid values: RELEASE TEST	RELEASE
HistoryVersion	string	The historical version of the API.	20160705104552393
ApiName	string	The name of the API.	CreateObject
RegionId	string	The region in which the API is located.	cn-qingdao

Examples

Sample success responses

JSONformat

{
  "PageNumber": 3,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ003",
  "PageSize": 15,
  "TotalCount": 32,
  "ApiHisItems": {
    "ApiHisItem": [
      {
        "Status": "ONLINE",
        "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
        "Description": "Creates an object\n",
        "GroupName": "myGroup2",
        "GroupId": "1084f9034c744137901057206b39d2b6",
        "DeployedTime": "2016-07-20T08:28:48Z",
        "StageName": "RELEASE",
        "HistoryVersion": "20160705104552393",
        "ApiName": "CreateObject\n",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history