DescribeHistoryApis Overview for Historical API Versions - API Gateway - Alibaba Cloud - API Gateway

Queries the historical versions of an API.

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:DescribeHistoryApis

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.	0ccb66aadb5345b78a40f57d192d8aa4
StageName	string	No	The name of the runtime environment. Valid values: RELEASE TEST	RELEASE
ApiId	string	No	The ID of the API.	a12068f555964ca8a0c9c33288f1e5a7
ApiName	string	No	The name of the API. The name is used for fuzzy match.	getPersonInfo
PageSize	string	No	The number of entries to return on each page.	10
PageNumber	string	No	The page number of the current page.	2

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	6C87A26A-6A18-4B8E-8099-705278381A2C
PageSize	integer	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
TotalCount	integer	The total number of returned entries.	20
ApiHisItems	object
ApiHisItem	array<object>	The returned API information. It is an array consisting of ApiHisItems.
	object
Status	string	Indicates whether an API version is effective. Valid values: ONLINE and OFFLINE.	ONLINE
ApiId	string	The API ID.	5af418828f0344a3b588c0cc1331a3bc
Description	string	The API description.	Create object API
GroupName	string	The name of the API group to which the API belongs.	myGroup2
GroupId	string	The API group ID.	1084f9034c744137901057206b39d2b6
DeployedTime	string	The time when the API was published. The time is displayed in UTC.	2016-07-20T08:28:48Z
StageName	string	The environment name. Valid values: RELEASE TEST	RELEASE
StageAlias	string	The environment alias.	Production
HistoryVersion	string	The historical version of the API definition.	20210915101416294
ApiName	string	The API name.	v2_role_assign
RegionId	string	The region ID.	cn-qingdao

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "6C87A26A-6A18-4B8E-8099-705278381A2C",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiHisItems": {
    "ApiHisItem": [
      {
        "Status": "ONLINE",
        "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
        "Description": "Create object API",
        "GroupName": "myGroup2",
        "GroupId": "1084f9034c744137901057206b39d2b6",
        "DeployedTime": "2016-07-20T08:28:48Z",
        "StageName": "RELEASE",
        "StageAlias": "Production",
        "HistoryVersion": "20210915101416294",
        "ApiName": "v2_role_assign",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.