DescribeServiceLog - Platform For AI - Alibaba Cloud Documentation Center

Queries the information about the logs of a service.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
eas:DescribeServiceLog	get	*Service `acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
PageNum	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 500.	500
Ip	string	No	The IP address of the instance whose logs you want to query. For more information about how to query the IP address of an instance, see ListServiceInstances .	10.0.0.1
Keyword	string	No	The keyword that you use to query the logs of the service.	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
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
InstanceName	string	No	The name of the instance that runs the service. For more information about how to query the instance name, see ListServiceInstances .	echo-da290ac8-7fckm
ContainerName	string	No	The name of the container that runs the service.	worker0
Previous	boolean	No	Specifies whether to query the logs that are generated before the instance last restarts. This parameter is available only if the instance restarts. Valid values: true false	true

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-05-09	The request parameters of the API has changed	View Change Details
2023-03-10	The request parameters of the API has changed	View Change Details