GetParseProgress - Elastic Desktop Service - Alibaba Cloud Documentation Center

Retrieves the parsed content of a skill package.

Operation description

Call the ParseSkillPackage operation first. Poll this operation every 3 seconds.

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

ecd:GetParseProgress

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskKey	string	Yes	The task key for parsing the skill package.	2E7D8B71-2677-1B4C-9E25-A88B9C5******

TaskKey parameter: After calling the ParseSkillPackage operation and obtaining the response, extract the value of the TaskKey field from the data object in the response.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Data	object	The response data object for parsing the skill package.
TaskKey	string	The task key for parsing the skill package.	2E7D8B71-2677-1B4C-9E25-A88B9C5******
Status	string	The task status. Valid values: PARSING_METADATA: parsing in progress. COMPLETED: completed. FAILED: failed. Valid values: PARSING_METADATA : Parsing in progress. COMPLETED : Completed. FAILED : Failed.	COMPLETED
SkillName	string	The name in the SKILL.md file.	name****
Slug	string	The skill slug identifier. This is user-defined and unique within the tenant dimension.	admapix******
Version	string	The version number.	1.0.0
RequiredEnvVars	array
	string
RequiresApiKey	boolean
Description	string
ErrorCode	string	The error code returned when an execution exception occurs.	Package.ReadFailed
ErrorMessage	string	The error message returned when an execution exception occurs.	Failed to read skill package

Slug parameter: After calling the GetParseProgress operation and obtaining the response, extract the value of the Slug field from the Data object within the data field of the response.

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Data": {
    "TaskKey": "2E7D8B71-2677-1B4C-9E25-A88B9C5******",
    "Status": "COMPLETED",
    "SkillName": "name****",
    "Slug": "admapix******",
    "Version": "1.0.0",
    "RequiredEnvVars": [
      ""
    ],
    "RequiresApiKey": false,
    "Description": "",
    "ErrorCode": "Package.ReadFailed",
    "ErrorMessage": "Failed to read skill package"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.