StartAIAnalysis - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Starts AI job analysis.

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

get

*All Resource

*

None

Request syntax

POST /api/v1/openapi/proxy/post/start_ai_analysis HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
analysisTool	string	No	The analysis tool. This parameter does not need to be specified when you call this operation by using OpenAPI.	gp/pyki/analysis
analysis_params	array	No	The data richness.
	string	No	gpu: GPU operators. python: Python call stacks. cPU: CPU information. torch: Torch GPU memory information. flops: floating-point operations count. Valid values: python : Python call stacks. memory : Torch GPU memory information. cpu : CPU information. flops : Floating-point operations count. gpu : GPU operators.	[gpu,cpu,torch]
channel	string	No	The channel name.	ecs_sysom
comms	string	No	The process name. This parameter is optional.	python_test
created_by	string	No	The creator. This parameter does not need to be specified when you call this operation by using OpenAPI.	445333
instance	string	No	The instance ID.	i-wz9dej066kii4goqxxxx
instance_type	string	No	The instance type. This parameter does not need to be specified when you call this operation by using OpenAPI.	ip/sn/hostname
iteration_func	string	No	The iteration entry function. This parameter is required only in iteration mode and can be left empty.	Class.function
iteration_mod	string	No	The iteration entry module. This parameter is required only in iteration mode and can be left empty.	a.b.module
iteration_range	array	No	The iteration range. The iteration count refers to the number of iterations when the data collection module is activated, which is independent of the AI job iteration count.
	integer	No	[start iteration count, end iteration count]	[5,14]
pids	string	No	The process IDs (PIDs) of the AI job. Multiple PIDs are supported and separated by commas (,).	2421,36547,10043
region	string	No	The region ID.	cn-shenzhen
timeout	integer	No	The AI Infra analysis duration. Unit: milliseconds. Default value: 2000.	2000
uid	string	No	The Alibaba Cloud account ID. This parameter does not need to be specified when you call this operation by using OpenAPI.	123423414

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The return code.	Success
data	object	The response data.
analysis_id	string	The AI analysis ID.	16896fa8-37f6-4c70-bb32-67fa9817d426
message	string	The error message.	""
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": {
    "analysis_id": "16896fa8-37f6-4c70-bb32-67fa9817d426"
  },
  "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.