Query service logs using DescribeServiceLog - Platform For AI - Alibaba Cloud - Platform For AI

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

eas:DescribeServiceLog

get

*Service

acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}

None

Request syntax

GET /api/v2/services/{ClusterId}/{ServiceName}/logs HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the region where the service is deployed.	cn-shanghai
ServiceName	string	Yes	The service name. For more information about how to query the service name, see ListServices.	echo

Request parameters

Parameter	Type	Required	Description	Example
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 500.	500
Ip	string	No	The IP address of the instance to query logs for. For more information about how to query instance IP addresses, see ListServiceInstances.	10.0.0.1
Keyword	string	No	The keyword used to filter service logs.	key
StartTime	string	No	The beginning of the time range to query. The time must be in Coordinated Universal Time (UTC).	2006-01-02 15:04:05
EndTime	string	No	The end of the time range to query. The time must be in UTC.	2006-01-02 15:04:05
InstanceName	string	No	The name of the instance running the service. For more information about how to query instance names, see ListServiceInstances.	echo-da290ac8-7fckm
ContainerName	string	No	The name of the container running the service.	worker0
Previous	boolean	No	Specifies whether to query logs generated before the instance last restarted. This parameter takes effect only if the instance has restarted. Valid values: true false Valid values: true : true false : false	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	40325405-579C-4D82********
Logs	array	The returned logs.
	string	The log entry.	echo_test
PageNum	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	1
TotalPageNum	integer	The total number of pages returned.	500

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82********",
  "Logs": [
    "echo_test"
  ],
  "PageNum": 1,
  "TotalCount": 1,
  "TotalPageNum": 500
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.