VerifyPythonFile - Security Center - Alibaba Cloud Documentation Center

Verifies the syntax of a Python code snippet.

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

yundun-sas:VerifyPythonFile

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Content	string	Yes	The Python code snippet to verify.	import logging def execute (params): success=True message='OK' data=[] return (success,message,data)

Response elements

Element	Type	Description	Example
	object	The code hinting information returned after verification.
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.	F72685FB-A6E6-5A9A-97F7-6DC1056E63CE
Syntax	array<object>	The result set of the Python code verification. If this parameter is empty, the code syntax is correct.
	object
StartLineNumber	integer	The starting line number of the code that contains an error.	2
StartColumn	integer	The starting column number of the code that contains an error.	2
EndLineNumber	integer	The ending line number of the code that contains an error.	5
EndColumn	integer	The ending column number of the code that contains an error.	5
Message	string	The error message for the code.	undefined name 'ab'
Severity	integer	The error level of the code. 4: General error 8: Critical error Valid values: 4 : General error 8 : Critical error	4

Examples

Success response

JSON format

{
  "RequestId": "F72685FB-A6E6-5A9A-97F7-6DC1056E63CE",
  "Syntax": [
    {
      "StartLineNumber": 2,
      "StartColumn": 2,
      "EndLineNumber": 5,
      "EndColumn": 5,
      "Message": "undefined name 'ab'",
      "Severity": 4
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
491	Playbook.External.ParamError	The parameters of the request interface are wrong. Please verify the parameters and request again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.