Querying Skill Packages in Batches_Skill Packages_Workspace APIs_API Reference

Function

This API is used to query the information about skill packages that are currently in effect in batches based on the skill ID list.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

workspace:skillPackage:listLatestPackage

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:skillPackage:listLatestPackage	List	-	-	-	-

URI

POST /v3/ai-agents/skill-packages/batch-query

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	No	String	Language, which is used for internationalization. en-us: English. zh-cn: Chinese.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
skill_ids	Yes	Array of strings	Skill IDs.

Response Parameters

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-Request-Id	String	-

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number of returned skill packages.
items	Array of BatchListSkillPackageItem objects	List of skill package query results.

**Table 5** BatchListSkillPackageItem
Parameter	Type	Description
skill_id	String	Skill ID.
current_package	CurrentPackageInfo object	Information about the skill package that is currently effective. If no package is effective, the value is null.

**Table 6** CurrentPackageInfo
Parameter	Type	Description
id	String	Skill package ID.
version	String	Version.
revision	Integer	Version revision number.
package_status	String	Skill package status.
regions	Array of strings	Deployed region IDs.

Status code: 400

**Table 7** Response header parameters
Parameter	Type	Description
X-Request-Id	String	-

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 9** Response header parameters
Parameter	Type	Description
X-Request-Id	String	-

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 11** Response header parameters
Parameter	Type	Description
X-Request-Id	String	-

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 13** Response header parameters
Parameter	Type	Description
X-Request-Id	String	-

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Example Requests

/v3/ai-agents/skill-packages/batch-query

{
  "skill_ids" : [ "skill-uuid-001", "skill-uuid-002" ]
}

Example Responses

Status code: 200

{
  "count" : 2,
  "items" : [ {
    "skill_id" : "skill-uuid-001",
    "current_package" : {
      "id" : "pkg-uuid-001",
      "version" : "1.0.0",
      "revision" : 1,
      "package_status" : "PUBLISHED",
      "regions" : [ "cn-north-7", "cn-south-1" ]
    }
  }, {
    "skill_id" : "skill-uuid-002",
    "current_package" : {
      "id" : "pkg-uuid-010",
      "version" : "1.0.0",
      "revision" : 1,
      "package_status" : "PUBLISHED",
      "regions" : [ "cn-north-7" ]
    }
  } ]
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal Server Error

Error Codes

See Error Codes.

Querying Skill Packages in Batches