GetParseProgress - Elastic Desktop Service - Alibaba Cloud ドキュメントセンター

スキルパッケージの解析済みコンテンツを取得します。

操作説明

まず ParseSkillPackage 操作を呼び出してください。この操作は 3 秒ごとにポーリングしてください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecd:GetParseProgress

none

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskKey	string	必須	スキルパッケージを解析するためのタスクキー。	2E7D8B71-2677-1B4C-9E25-A88B9C5******

TaskKey パラメーター: ParseSkillPackage 操作を呼び出して応答を取得した後、応答内の data オブジェクトから TaskKey フィールドの値を抽出してください。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Data	object	スキルパッケージ解析の応答データオブジェクト。
TaskKey	string	スキルパッケージを解析するためのタスクキー。	2E7D8B71-2677-1B4C-9E25-A88B9C5******
Status	string	タスクのステータス。有効な値: PARSING_METADATA: 解析中。 COMPLETED: 完了。 FAILED: 失敗した。列挙値: PARSING_METADATA : 解析中。 COMPLETED : 完了。 FAILED : 失敗。	COMPLETED
SkillName	string	SKILL.md ファイル内の名前。	name****
Slug	string	スキルのスラグ識別子。ユーザー定義であり、テナントディメンション内で一意です。	admapix******
Version	string	バージョン番号。	1.0.0
RequiredEnvVars	array
	string
RequiresApiKey	boolean
Description	string
ErrorCode	string	実行例外が発生した場合に返されるエラーコード。	Package.ReadFailed
ErrorMessage	string	実行例外が発生した場合に返されるエラーメッセージ。	Failed to read skill package

Slug パラメーター: GetParseProgress 操作を呼び出して応答を取得した後、応答の data フィールド内の Data オブジェクトから Slug フィールドの値を抽出してください。

例

成功レスポンス

JSONJSON

{
  "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"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。