Queries the log of an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters and common response parameters.

Request syntax

GET /pop/v1/sam/instance/describeInstanceLog HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
InstanceId String Query Yes ******-d700e680-aa4d-4ec1-afc2-6566b5ff4d7a-85d44d4bfc-*****

The ID of the instance whose log you want to query.

Response parameters

Parameter Type Example Description
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

The ID of the request.

Message String success

The returned message.

  • success is returned when the request succeeds.
  • An error code is returned when the request fails.
TraceId String 0a98a02315955564772843261e****

The ID of the trace.

Data String hello\nsae\n

The log of the instance.

ErrorCode String This parameter is left empty.

The error code.

  • The ErrorCode parameter is not returned when the request succeeds.
  • The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code String 200

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request was invalid.
  • 5xx: indicates that a server error occurred.
Success Boolean true

Indicates whether the log of the instance was obtained. Valid values:

  • true: indicates that the log was obtained.
  • false: indicates that the log could not be obtained.

Examples

Sample requests

GET /pop/v1/sam/instance/describeInstanceLog?InstanceId=******-d700e680-aa4d-4ec1-afc2-6566b5ff4d7a-85d44d4bfc-***** HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceLogResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>hello\nsae\n</Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeInstanceLogResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a98a02315955564772843261e****",
  "Data" : "hello\\nsae\\n",
  "Code" : "200",
  "Success" : true
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter.NotEmpty You must specify the parameter %s. The error message returned because the value of the %s parameter is invalid. This parameter cannot be left empty.

For a list of error codes, visit the API Error Center.