Call DescribeApiHistories to query historical versions of an API - API Gateway - Alibaba Cloud - API Gateway

Queries the historical versions of a specified API.

Operation description

Intended for API providers. Only published APIs have historical version records.
Returns historical version data for an API, always called by other operations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DescribeApiHistories

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

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. Supports fuzzy match.	weather
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1

Response elements

Element	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
ApiHisItem	array<object>	The returned API history information.
	object
Status	string	Whether the API version is active. 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 time when the API version was published, in UTC.	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.