GetInstanceEvents-阿里云帮助中心

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

paidsw:GetInstanceEvents

get

*All Resource

*

None

Request syntax

GET /api/v2/instances/{InstanceId}/events HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	dsw-730xxxxxxxxxx

Request parameters

Parameter	Type	Required	Description	Example
MaxEventsNum	integer	No	The maximum number of events to return. The default value is 2000.	2000
StartTime	string	No	The start time of the query range.	2020-11-08T15:00:00Z
EndTime	string	No	The end time of the query range.	2020-11-08T15:00:00Z
Token	string	No	A token for URL sharing.
EventLevel	string	No

Response elements

Element	Type	Description	Example
	object	The list of events for the DSW instance.
RequestId	string	The request ID.	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	Indicates whether the request succeeded. Valid values: true false	true
Message	string	The response message.	XXX
Code	string	The status code. Valid values: `InternalError`: An internal error. This value is returned for any error that is not a parameter validation error. `ValidationError`: A parameter validation error.	None
HttpStatusCode	integer	The HTTP status code. Valid values: `400`: The input parameters are invalid. `404`: The instance does not exist. `200`: The request succeeded.	200
InstanceId	string	The instance ID.	dsw-730xxxxxxxxxx
Events	array	The list of instance events.
	string	The event message.	You are using pip version 9.0.1, however version 20.2.4 is available.
TotalCount	integer	The total number of entries returned.

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "XXX\n",
  "Code": "None",
  "HttpStatusCode": 200,
  "InstanceId": "dsw-730xxxxxxxxxx",
  "Events": [
    "You are using pip version 9.0.1, however version 20.2.4 is available. "
  ],
  "TotalCount": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.