CreateVmcoreDiagnosisTask - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

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:CreateVmcoreDiagnosisTask

none

*All Resource

*

None

Request syntax

POST /api/v1/crashAgent/diagnosis/createDiagnosisTask HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
debuginfoCommonUrl	string	No	The download URL of the debuginfo-common file. This parameter is optional when the diagnosis type is vmcore. For CentOS or Alinux kernel diagnostics, the corresponding debuginfo-common file is automatically downloaded, so this parameter is not required. For other distribution kernels, manually provide the download URL of the debuginfo-common file that corresponds to the kernel version.	https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo-common/file/path
debuginfoUrl	string	No	The download URL of the debuginfo file. This parameter is optional when the diagnosis type is vmcore. For CentOS or Alinux kernel diagnostics, the corresponding debuginfo file is automatically downloaded, so this parameter is not required. For other distribution kernels, manually provide the download URL of the debuginfo file that corresponds to the kernel version.	https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo/file/path
dmesgUrl	string	No	The download URL of the dmesg log file. This parameter is required when the diagnosis type is dmesg.	https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dmesg/file/path
taskType	string	Yes	The task type. Valid values: vmcore: a vmcore file diagnostic task. dmesg: a dmesg log diagnostic task. Valid values: dmesg : dmesg vmcore : vmcore	vmcore
vmcoreUrl	string	No	The download URL of the vmcore file. This parameter is required when the diagnosis type is vmcore.	https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/vmcore/file/path

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. If `code == Success`, the authorization is successful. Other status codes indicate authorization failed. Check the `message` field for the detailed fault information.	Success
data	object	The returned data.
taskId	string	The ID of the created diagnostic task.	bbe94a98-4192-4172-b856-95777e0a55d7
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	""
requestId	string	The request ID.	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": {
    "taskId": "bbe94a98-4192-4172-b856-95777e0a55d7"
  },
  "message": "\"\"",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.