ListDiagnosis - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves a list of diagnostic history records.

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

sysom:ListDiagnosis

list

*All Resource

*

None

Request syntax

GET /api/v1/openapi/diagnosis/list_diagnosis HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
current	integer	No	The current page number.	1
pageSize	integer	No	The number of entries per page.	10
service_name	string	No	The diagnostic type.	memgraph
params	string	No	The diagnostic parameters. Different diagnostic types require different diagnostic parameters. You can use this field to filter records whose parameters match the specified values.	[{\"key\":\"region\",\"value\":\"cn-beijing\"}]
status	string	No	The execution status of the diagnostic task. Valid values: Ready: Ready. Running: Running. Success: Succeeded. Fail: Failed.	Running

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	44841312-7227-55C9-AE03-D59729BFAE38
code	string	The status code. `code == Success` indicates that the authorization is successful. Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.	Success
data	array<object>	The returned data.
	object	The returned object of a single analysis record.
code	integer	The diagnostic error code. A value of 0 indicates no error.	0
command	any	The diagnostic command.	{ "jobs":[ { "cmd":"mkdir -p /var/log/sysak && sysak podmem -r 100 -a -j /var/log/sysak/podmem.json > /dev/null 2>&1 && cat /var/log/sysak/podmem.json", "instance":"172.20.12.174", "fetch_file_list":[ ] } ], "in_order":true, "offline_mode":false, "offline_results":[ ] }
created_at	string	The creation time.	2024-12-25T15:08:19
err_msg	string	The error message.	Diagnosis failed
params	any	The diagnostic parameters.	{ "type":"all", "value":"", "channel":"ssh", "instance":"172.1.2.174", "service_name":"filecache" }
result	any	The diagnostic result.	{ "summary":" memory cgroup leak", "dataMemEvent":{ "data":[ { "key":"Util", "value":20 }, { "key":"MemLeak", "value":"OK" }, { "key":"MemcgLeak", "value":"NG" }, { "key":"MemFrag", "value":"OK" } ] }, "dataMemOverView":{ "data":[ { "key":"app", "value":10937332 }, { "key":"free", "value":806800 }, { "key":"kernel", "value":4527660 } ] }, "dataKerMem":{ "data":[ { "key":"SReclaimable", "value":3411292 }, { "key":"VmallocUsed", "value":30980 }, { "key":"allocPage", "value":177732 }, { "key":"KernelStack", "value":9280 }, { "key":"PageTables", "value":38056 }, { "key":"SUnreclaim", "value":170248 }, { "key":"reserved", "value":690072 } ] }, "dataUserMem":{ "data":[ { "key":"filecache", "value":8010008 }, { "key":"anon", "value":2468608 }, { "key":"mlock", "value":0 }, { "key":"huge1G", "value":0 }, { "key":"huge2M", "value":0 }, { "key":"buffers", "value":458608 }, { "key":"shmem", "value":2284 } ] }, "dataCacheList":{ "data":[ { "key":0, "Name":"/var/lib/mysql/sysom/sys_handler_log.ibd", "cached":576764, "Task":"mysqld_78575 " }, { "key":1, "Name":"/var/log/sysom/sysom-migration-access.log", "cached":276688, "Task":"gunicorn_33647 ,gunicorn_460836 ,gunicorn_559934 ,gunicorn_731758 ,gunicorn_2362682 " }, { "key":2, "Name":"/var/log/sysom/sysom-rtdemo-access.log", "cached":229404, "Task":"gunicorn_60718 ,gunicorn_720734 ,gunicorn_722168 " }, { "key":3, "Name":"/var/log/sysom/sysom-monitor-server-access.log", "cached":197368, "Task":"gunicorn_33682 ,gunicorn_671155 ,gunicorn_714998 " }, { "key":4, "Name":"/var/log/sysom/sysom-channel-access.log", "cached":180276, "Task":"gunicorn_33233 ,gunicorn_499735 ,gunicorn_725497 " }, { "key":5, "Name":"total cached of close file", "cached":3729668, "Task":"" } ] }, "dataProcMemList":{ "data":[ { "key":0, "task":"mysqld", "MemTotal":240856, "RssAnon":218248, "RssFile":22608 }, { "key":1, "task":"systemd-journal", "MemTotal":150248, "RssAnon":74300, "RssFile":75944 }, { "key":2, "task":"gunicorn", "MemTotal":144640, "RssAnon":114200, "RssFile":30440 }, { "key":3, "task":"gunicorn", "MemTotal":141480, "RssAnon":111040, "RssFile":30440 }, { "key":4, "task":"grafana-server", "MemTotal":103660, "RssAnon":42732, "RssFile":60928 }, { "key":5, "task":"gunicorn", "MemTotal":97444, "RssAnon":76256, "RssFile":21188 }, { "key":6, "task":"gunicorn", "MemTotal":97260, "RssAnon":76072, "RssFile":21188 }, { "key":7, "task":"prometheus", "MemTotal":95356, "RssAnon":45376, "RssFile":49980 }, { "key":8, "task":"gunicorn", "MemTotal":90144, "RssAnon":76456, "RssFile":13688 }, { "key":9, "task":"gunicorn", "MemTotal":89796, "RssAnon":76108, "RssFile":13688 } ] } }
service_name	string	The diagnostic type.	memgraph
status	string	The execution status of the diagnostic task. Valid values: Ready: Ready. Running: Running. Success: Succeeded. Fail: Failed.	Running
task_id	string	The task ID.	grcuU21a
updated_at	string	The update time.	2024-12-25T15:08:19
url	string	The URL of the diagnostic details.	/diagnose/detail/qe3Z34sa
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
total	integer	The total number of records.	319

Examples

Success response

JSON format

{
  "RequestId": "44841312-7227-55C9-AE03-D59729BFAE38",
  "code": "Success",
  "data": [
    {
      "code": 0,
      "command": "{\n    \"jobs\":[\n        {\n            \"cmd\":\"mkdir -p /var/log/sysak && sysak podmem -r 100  -a -j /var/log/sysak/podmem.json > /dev/null 2>&1 && cat /var/log/sysak/podmem.json\",\n            \"instance\":\"172.20.12.174\",\n            \"fetch_file_list\":[\n\n            ]\n        }\n    ],\n    \"in_order\":true,\n    \"offline_mode\":false,\n    \"offline_results\":[\n\n    ]\n}",
      "created_at": "2024-12-25T15:08:19",
      "err_msg": "Diagnosis failed",
      "params": "{\n    \"type\":\"all\",\n    \"value\":\"\",\n    \"channel\":\"ssh\",\n    \"instance\":\"172.1.2.174\",\n    \"service_name\":\"filecache\"\n}",
      "result": "{\n    \"summary\":\"  memory cgroup leak\",\n    \"dataMemEvent\":{\n        \"data\":[\n            {\n                \"key\":\"Util\",\n                \"value\":20\n            },\n            {\n                \"key\":\"MemLeak\",\n                \"value\":\"OK\"\n            },\n            {\n                \"key\":\"MemcgLeak\",\n                \"value\":\"NG\"\n            },\n            {\n                \"key\":\"MemFrag\",\n                \"value\":\"OK\"\n            }\n        ]\n    },\n    \"dataMemOverView\":{\n        \"data\":[\n            {\n                \"key\":\"app\",\n                \"value\":10937332\n            },\n            {\n                \"key\":\"free\",\n                \"value\":806800\n            },\n            {\n                \"key\":\"kernel\",\n                \"value\":4527660\n            }\n        ]\n    },\n    \"dataKerMem\":{\n        \"data\":[\n            {\n                \"key\":\"SReclaimable\",\n                \"value\":3411292\n            },\n            {\n                \"key\":\"VmallocUsed\",\n                \"value\":30980\n            },\n            {\n                \"key\":\"allocPage\",\n                \"value\":177732\n            },\n            {\n                \"key\":\"KernelStack\",\n                \"value\":9280\n            },\n            {\n                \"key\":\"PageTables\",\n                \"value\":38056\n            },\n            {\n                \"key\":\"SUnreclaim\",\n                \"value\":170248\n            },\n            {\n                \"key\":\"reserved\",\n                \"value\":690072\n            }\n        ]\n    },\n    \"dataUserMem\":{\n        \"data\":[\n            {\n                \"key\":\"filecache\",\n                \"value\":8010008\n            },\n            {\n                \"key\":\"anon\",\n                \"value\":2468608\n            },\n            {\n                \"key\":\"mlock\",\n                \"value\":0\n            },\n            {\n                \"key\":\"huge1G\",\n                \"value\":0\n            },\n            {\n                \"key\":\"huge2M\",\n                \"value\":0\n            },\n            {\n                \"key\":\"buffers\",\n                \"value\":458608\n            },\n            {\n                \"key\":\"shmem\",\n                \"value\":2284\n            }\n        ]\n    },\n    \"dataCacheList\":{\n        \"data\":[\n            {\n                \"key\":0,\n                \"Name\":\"/var/lib/mysql/sysom/sys_handler_log.ibd\",\n                \"cached\":576764,\n                \"Task\":\"mysqld_78575 \"\n            },\n            {\n                \"key\":1,\n                \"Name\":\"/var/log/sysom/sysom-migration-access.log\",\n                \"cached\":276688,\n                \"Task\":\"gunicorn_33647 ,gunicorn_460836 ,gunicorn_559934 ,gunicorn_731758 ,gunicorn_2362682 \"\n            },\n            {\n                \"key\":2,\n                \"Name\":\"/var/log/sysom/sysom-rtdemo-access.log\",\n                \"cached\":229404,\n                \"Task\":\"gunicorn_60718 ,gunicorn_720734 ,gunicorn_722168 \"\n            },\n            {\n                \"key\":3,\n                \"Name\":\"/var/log/sysom/sysom-monitor-server-access.log\",\n                \"cached\":197368,\n                \"Task\":\"gunicorn_33682 ,gunicorn_671155 ,gunicorn_714998 \"\n            },\n            {\n                \"key\":4,\n                \"Name\":\"/var/log/sysom/sysom-channel-access.log\",\n                \"cached\":180276,\n                \"Task\":\"gunicorn_33233 ,gunicorn_499735 ,gunicorn_725497 \"\n            },\n            {\n                \"key\":5,\n                \"Name\":\"total cached of close file\",\n                \"cached\":3729668,\n                \"Task\":\"\"\n            }\n        ]\n    },\n    \"dataProcMemList\":{\n        \"data\":[\n            {\n                \"key\":0,\n                \"task\":\"mysqld\",\n                \"MemTotal\":240856,\n                \"RssAnon\":218248,\n                \"RssFile\":22608\n            },\n            {\n                \"key\":1,\n                \"task\":\"systemd-journal\",\n                \"MemTotal\":150248,\n                \"RssAnon\":74300,\n                \"RssFile\":75944\n            },\n            {\n                \"key\":2,\n                \"task\":\"gunicorn\",\n                \"MemTotal\":144640,\n                \"RssAnon\":114200,\n                \"RssFile\":30440\n            },\n            {\n                \"key\":3,\n                \"task\":\"gunicorn\",\n                \"MemTotal\":141480,\n                \"RssAnon\":111040,\n                \"RssFile\":30440\n            },\n            {\n                \"key\":4,\n                \"task\":\"grafana-server\",\n                \"MemTotal\":103660,\n                \"RssAnon\":42732,\n                \"RssFile\":60928\n            },\n            {\n                \"key\":5,\n                \"task\":\"gunicorn\",\n                \"MemTotal\":97444,\n                \"RssAnon\":76256,\n                \"RssFile\":21188\n            },\n            {\n                \"key\":6,\n                \"task\":\"gunicorn\",\n                \"MemTotal\":97260,\n                \"RssAnon\":76072,\n                \"RssFile\":21188\n            },\n            {\n                \"key\":7,\n                \"task\":\"prometheus\",\n                \"MemTotal\":95356,\n                \"RssAnon\":45376,\n                \"RssFile\":49980\n            },\n            {\n                \"key\":8,\n                \"task\":\"gunicorn\",\n                \"MemTotal\":90144,\n                \"RssAnon\":76456,\n                \"RssFile\":13688\n            },\n            {\n                \"key\":9,\n                \"task\":\"gunicorn\",\n                \"MemTotal\":89796,\n                \"RssAnon\":76108,\n                \"RssFile\":13688\n            }\n        ]\n    }\n}",
      "service_name": "memgraph",
      "status": "Running",
      "task_id": "grcuU21a",
      "updated_at": "2024-12-25T15:08:19",
      "url": "/diagnose/detail/qe3Z34sa"
    }
  ],
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "total": 319
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.