ListServiceInstanceLogs - Compute Nest - Alibaba Cloud Documentation Center

Call the ListServiceInstanceLogs operation to query deployment, upgrade, and application logs for a service instance.

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

computenestsupplier:ListServiceInstanceLogs

list

*ServiceInstance

acs:computenestsupplier:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	20
NextToken	string	No	The token that specifies the next page of results to return. Set this parameter to the NextToken value from a previous response to retrieve the next page of results.	BBBAAfu+XtuBE55iRLHEYYuojI4=
ServiceInstanceId	string	Yes	The service instance ID.	si-70a3b15bb626435b****
LogSource	string	No	The source of the logs. Valid values: application: Logs from the application. computeNest: Logs from Compute Nest. ros: Logs from Resource Orchestration Service (ROS).	computeNest
Logstore	string	No	The name of the Simple Log Service Logstore.	livelog
Filter	array<object>	No	The filters.
	object	No	A filter.
Name	string	No	The name of the filter condition. Valid values: StartTime EndTime ApplicationGroupName ResourceName EventName	StartTime
Value	array	No	The values for the filter condition. You can specify up to 10 values.
	string	No	A filter value.	2022-01-01T22:22:22Z
SortOrder	string	No	The sort order. Valid values: Ascending: Ascending order. Descending (default): Descending order.	Ascending

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token to retrieve the next page of results. If this parameter is empty, all results have been returned.	AAAAAfu+XtuBE55iRLHEYYuojI4=
RequestId	string	The request ID.	51945B04-6AA6-410D-93BA-236E0248B104
MaxResults	integer	The number of entries returned on each page.	20
ServiceInstancesLogs	array<object>	The logs of the service instance.
	object	The details of a log entry.
Timestamp	string	The timestamp of the log entry.	2022-05-21T00:00:00Z
Source	string	The source of the log. Valid values: ros: Logs from ROS. computeNest: Logs from Compute Nest. application: Logs from the application in the instance. compliancePack: Logs from the compliance package of the instance. actionTrail: Logs from ActionTrail.	computeNest
Content	string	The content of the log entry.	Start creating service instance
LogType	string	The log type. Valid values: serviceInstance: Logs at the service instance level. resource: Logs at the ROS resource level.	serviceInstance
ResourceType	string	The resource type.	ROS.Stack
ResourceId	string	The ID of the associated resource.	si-5c6525c0589545c3****
Status	string	The status of the event that the log records. Valid values: Creating: The instance is being created. Created: The instance is created. Deploying: The instance is being deployed. Deployed: The instance is deployed. DeployedFailed: The instance failed to be deployed. Expired: The instance has expired. ExtendSuccess: The instance is successfully renewed. Upgrading: The instance is being upgraded. UpgradeSuccess: The instance is successfully upgraded.	Deployed
CompliancePackType	string	The threat type from the compliance package. This parameter is returned only when Source is set to compliancePack. For example, VpcDataRisk indicates a data security check within a VPC.	VpcDataRisk
ComplianceRuleName	string	The name of the threat rule from the compliance package. This parameter is returned only when Source is set to compliancePack. For example, vpc-ecs-move-out-vpc indicates that an ECS instance was moved out of a VPC.	vpc-ecs-move-out-vpc

Examples

Success response

JSON format

{
  "NextToken": "AAAAAfu+XtuBE55iRLHEYYuojI4=",
  "RequestId": "51945B04-6AA6-410D-93BA-236E0248B104",
  "MaxResults": 20,
  "ServiceInstancesLogs": [
    {
      "Timestamp": "2022-05-21T00:00:00Z",
      "Source": "computeNest",
      "Content": "Start creating service instance",
      "LogType": "serviceInstance",
      "ResourceType": "ROS.Stack",
      "ResourceId": "si-5c6525c0589545c3****",
      "Status": "Deployed",
      "CompliancePackType": "VpcDataRisk",
      "ComplianceRuleName": "vpc-ecs-move-out-vpc"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.