Querying TMLog Information

Function

This API is used to query TMLog information.

TMLogs record XA transaction information to support transaction recovery.

Constraints

None

API Calling

For details, see Calling APIs.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies
ddm:instance:getTmlogs

Read

instance *

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ddm:instance:getTmlogs	Read	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

GET /v3/{project_id}/instances/{instance_id}/tmlogs

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in09. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. Constraints N/A Range The value is greater than or equal to 0. Default Value The default value is 0.
limit	No	Integer	Definition Number of records to be queried. Constraints N/A Range The value is greater than 0 and less than or equal to 128. Default Value The default value is 10.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Constraints N/A Range N/A Default Value N/A

Example Request

Querying TMLog information

GET https://{endpoint}/v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/instances/b7eabbbc6bxxxxxxxxxxadfffa99a7c2in09/tmlogs

Response Parameters

Normal response

**Table 4** Response body parameters
Parameter	Type	Description
tmlogs	Array of TmlogInfo objects	TMLog information list.
total	Integer	Total number of TMLog nodes that are found.

**Table 5** TmlogInfo
Parameter	Type	Description
node_id	String	Node ID
file_list	Array of strings	Compressed files
tmlog_size	Number	TMLog file size, in MB.

Example Response

Normal response example

{
  "tmlogs" : [ {
    "node_id" : "d768e14643xxxxxxxxxxxxxx692dcfa5no09",
    "file_list" : [ ],
    "tmlog_size" : 0
  }, {
    "node_id" : "3422de7fc5xxxxxxxxxxxxxxd9a7f675no09",
    "file_list" : [ ],
    "tmlog_size" : 0
  } ],
  "total" : 2
}