summaryrefslogtreecommitdiff
path: root/data/zh_cn/agentexplorer/2026-03-17/api-docs.php
blob: e13c00c99a0bd40b88bd1a3980b8177224f63232 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'AgentExplorer', 'version' => '2026-03-17'],
    'directories' => ['GetSkillContent', 'SearchSkills', 'ListCategories'],
    'components' => [
        'schemas' => [
            'Category' => [
                'description' => '类目详情',
                'type' => 'object',
                'properties' => [
                    'code' => ['title' => '一级类目Code', 'description' => '一级类目Code', 'type' => 'string', 'example' => 'compute'],
                    'name' => ['title' => '一级类目名称', 'description' => '一级类目名称', 'type' => 'string', 'example' => '计算'],
                    'children' => [
                        'title' => '子类目',
                        'description' => '子类目',
                        'type' => 'array',
                        'items' => [
                            'type' => 'object',
                            'properties' => [
                                'code' => ['title' => '二级类目Code', 'description' => '二级类目Code', 'type' => 'string', 'example' => 'ecs'],
                                'name' => ['title' => '二级类目名称', 'description' => '二级类目名称', 'type' => 'string', 'example' => '弹性计算'],
                            ],
                            'description' => '',
                        ],
                    ],
                ],
            ],
            'Skill' => [
                'description' => 'Agent Skill 详情',
                'type' => 'object',
                'properties' => [
                    'skillName' => ['title' => 'Agent Skill 英文名,唯一标识符', 'description' => 'Agent Skill 英文名,唯一标识符', 'type' => 'string', 'example' => 'deploy-to-vercel'],
                    'displayName' => ['title' => 'Agent Skill 展示名称', 'description' => 'Agent Skill 展示名称', 'type' => 'string', 'example' => 'ECS 实例管理'],
                    'description' => ['title' => 'Agent Skill 描述', 'description' => 'Agent Skill 描述', 'type' => 'string', 'example' => 'ECS 实例管理'],
                    'categoryCode' => ['title' => '一级类目Code', 'description' => '一级类目Code', 'type' => 'string', 'example' => 'compute'],
                    'categoryName' => ['title' => '一级类目名称', 'description' => '一级类目名称', 'type' => 'string', 'example' => '计算'],
                    'subCategoryCode' => ['title' => '二级类目Code', 'description' => '二级类目Code', 'type' => 'string', 'example' => 'ecs'],
                    'subCategoryName' => ['title' => '二级类目名称', 'description' => '二级类目名称', 'type' => 'string', 'example' => '弹性计算'],
                    'likeCount' => ['title' => '点赞数', 'description' => '点赞数', 'type' => 'integer', 'format' => 'int32', 'example' => '128'],
                    'installCount' => ['title' => '安装数', 'description' => '安装数', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'],
                    'createdAt' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-01-01T00:00:00Z'],
                    'updatedAt' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2026-03-17T00:00:00Z'],
                    'descriptionEn' => ['type' => 'string'],
                    'nameEn' => ['type' => 'string'],
                    'categoryNameEn' => ['type' => 'string'],
                    'subCategoryNameEn' => ['type' => 'string'],
                    'githubPath' => ['type' => 'string'],
                ],
            ],
        ],
    ],
    'apis' => [
        'GetSkillContent' => [
            'summary' => '获取指定 Agent Skill 的 SKILL.md 文件内容',
            'path' => '/openapi/skills/{skillName}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'get',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeNodes' => ['FEATUREopenapiexplorerIZJ64T'],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'skillName',
                    'in' => 'path',
                    'schema' => ['title' => 'skill name', 'description' => 'skill name', 'type' => 'string', 'required' => true, 'example' => 'ecs-manager'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1764D64D-5262-55DA-BDBF-1F949B1B34F7'],
                            'content' => ['title' => 'SKILL.md 文件内容', 'description' => 'SKILL.md 文件内容', 'type' => 'string', 'example' => '---'."\n"
                                .'name: alibabacloud-find-skills'."\n"
                                .'description: "Search for official Alibaba Cloud Agent Skills based on user requirements"'."\n"
                                .'---'."\n"
                                ."\n"
                                .'Agent Skill Body Content Here'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                404 => [
                    ['errorCode' => 'NotFound.Skill', 'errorMessage' => 'Specified skill not found.', 'description' => '指定的Skill不存在。'],
                ],
                500 => [
                    ['errorCode' => 'InternalServerError', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '由于服务器暂时故障,请求失败。'],
                    ['errorCode' => 'OperationFailed', 'errorMessage' => 'Get skill content failed.', 'description' => '获取Skill内容失败。'],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"requestId\\": \\"1764D64D-5262-55DA-BDBF-1F949B1B34F7\\",\\n  \\"content\\": \\"---\\\\nname: alibabacloud-find-skills\\\\ndescription: \\\\\\"Search for official Alibaba Cloud Agent Skills based on user requirements\\\\\\"\\\\n---\\\\n\\\\nAgent Skill Body Content Here\\"\\n}","type":"json"}]',
            'title' => '获取 Agent Skill 文件内容',
            'changeSet' => [],
        ],
        'ListCategories' => [
            'summary' => '列举所有的阿里云 Skills 类目。',
            'path' => '/openapi/categories',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'list',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeNodes' => ['FEATUREopenapiexplorerIZJ64T'],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '099A671E-FA21-5A36-8A73-918572DDEF53'],
                            'message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'success'],
                            'data' => [
                                'description' => '返回的类目列表',
                                'type' => 'array',
                                'items' => ['description' => '返回的类目详情', '$ref' => '#/components/schemas/Category'],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                500 => [
                    ['errorCode' => 'InternalServerError', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '由于服务器暂时故障,请求失败。'],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"requestId\\": \\"099A671E-FA21-5A36-8A73-918572DDEF53\\",\\n  \\"message\\": \\"success\\",\\n  \\"data\\": [\\n    {\\n      \\"code\\": \\"compute\\",\\n      \\"name\\": \\"计算\\",\\n      \\"children\\": [\\n        {\\n          \\"code\\": \\"ecs\\",\\n          \\"name\\": \\"弹性计算\\"\\n        }\\n      ]\\n    }\\n  ]\\n}","type":"json"}]',
            'title' => '获取所有 Agent Skills 类目信息',
            'changeSet' => [],
        ],
        'SearchSkills' => [
            'summary' => '通过关键词、类目搜索阿里云 Agent Skills。',
            'path' => '/openapi/skills',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'get',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeNodes' => ['FEATUREopenapiexplorerIZJ64T'],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'keyword',
                    'in' => 'query',
                    'schema' => ['title' => '搜索关键词', 'description' => '搜索关键词', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
                ],
                [
                    'name' => 'categoryCode',
                    'in' => 'query',
                    'schema' => ['title' => 'Skill 类目Code,如果传入多个,使用英文逗号隔开。如果是二级类目,使用 一级类目.二级类目的方式传入', 'description' => 'Skill 类目Code,如果传入多个,使用英文逗号隔开。如果是二级类目,使用 一级类目.二级类目的方式传入', 'type' => 'string', 'required' => false, 'example' => 'compute.serverless,network'],
                ],
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['title' => '下一个查询开始 Token,取值为上一次 API 调用返回的 NextToken 参数值', 'description' => '下一个查询开始 Token,取值为上一次 API 调用返回的 NextToken 参数值', 'type' => 'string', 'required' => false, 'example' => 'AAAAAZjtYxxxxxxxx'],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['title' => '分页查询时每页的最大条目数。最大值为 100。默认值为 20。', 'description' => '分页查询时每页的最大条目数。最大值为 100。默认值为 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
                ],
                [
                    'name' => 'skip',
                    'in' => 'query',
                    'schema' => ['title' => '分页参数,跳过数目', 'description' => '分页参数,跳过数目', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
                ],
                [
                    'name' => 'searchMode',
                    'in' => 'query',
                    'schema' => ['title' => '开启向量搜索的方式需指定semantic', 'type' => 'string'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '53EAEBC0-4DEC-5AF4-AA21-3923D5A819C3'],
                            'nextToken' => ['title' => '返回的 NextToken,用来返回更多结果。', 'description' => '返回的 NextToken,用来返回更多结果。', 'type' => 'string', 'example' => 'AAAAAZjtYxxxxxxxx'],
                            'maxResults' => ['title' => '分页查询时每页的最大条目数。最大值为 100。默认值为 20。', 'description' => '分页查询时每页的最大条目数。最大值为 100。默认值为 20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
                            'totalCount' => ['title' => '数据总记录数。', 'description' => '数据总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '22'],
                            'data' => [
                                'description' => '返回的 Skill 列表',
                                'type' => 'array',
                                'items' => ['description' => '返回的Skill详情', '$ref' => '#/components/schemas/Skill'],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'InvalidParam.NextToken', 'errorMessage' => 'The specified NextToken is not valid.', 'description' => '指定的nextToken无效。'],
                    ['errorCode' => 'NextTokenParameterMismatch', 'errorMessage' => 'The request uses the same nextToken as the previous request, but with different parameters. NextTokens should not be reused across non-identical requests. Each unique request must have a distinct nextToken.', 'description' => '请求使用了与之前请求相同的nextToken,但参数不同。请勿在参数不同的请求中重复使用同一nextToken,每个独立请求必须使用唯一的nextToken。 '],
                ],
                500 => [
                    ['errorCode' => 'InternalServerError', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '由于服务器暂时故障,请求失败。'],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'title' => '搜索阿里云 Agent Skills',
            'changeSet' => [],
            'flowControl' => [
                'flowControlList' => [],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"requestId\\": \\"53EAEBC0-4DEC-5AF4-AA21-3923D5A819C3\\",\\n  \\"nextToken\\": \\"AAAAAZjtYxxxxxxxx\\",\\n  \\"maxResults\\": 20,\\n  \\"totalCount\\": 22,\\n  \\"data\\": [\\n    {\\n      \\"skillName\\": \\"deploy-to-vercel\\",\\n      \\"displayName\\": \\"ECS 实例管理\\",\\n      \\"description\\": \\"ECS 实例管理\\",\\n      \\"categoryCode\\": \\"compute\\",\\n      \\"categoryName\\": \\"计算\\",\\n      \\"subCategoryCode\\": \\"ecs\\",\\n      \\"subCategoryName\\": \\"弹性计算\\",\\n      \\"likeCount\\": 128,\\n      \\"installCount\\": 1024,\\n      \\"createdAt\\": \\"2026-01-01T00:00:00Z\\",\\n      \\"updatedAt\\": \\"2026-03-17T00:00:00Z\\",\\n      \\"descriptionEn\\": \\"\\",\\n      \\"nameEn\\": \\"\\",\\n      \\"categoryNameEn\\": \\"\\",\\n      \\"subCategoryNameEn\\": \\"\\",\\n      \\"githubPath\\": \\"\\"\\n    }\\n  ]\\n}","type":"json"}]',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'public', 'regionName' => '公网', 'areaId' => 'other', 'areaName' => '其它', 'public' => 'agentexplorer.aliyuncs.com', 'endpoint' => 'agentexplorer.aliyuncs.com', 'vpc' => ''],
    ],
    'errorCodes' => [
        ['code' => 'InternalServerError', 'message' => 'The request has failed due to a temporary failure of the server.', 'http_code' => 500, 'description' => '由于服务器暂时故障,请求失败。'],
        ['code' => 'InvalidParam.NextToken', 'message' => 'The specified NextToken is not valid.', 'http_code' => 400, 'description' => '指定的nextToken无效。'],
        ['code' => 'NextTokenParameterMismatch', 'message' => 'The request uses the same nextToken as the previous request, but with different parameters. NextTokens should not be reused across non-identical requests. Each unique request must have a distinct nextToken.', 'http_code' => 400, 'description' => '请求使用了与之前请求相同的nextToken,但参数不同。请勿在参数不同的请求中重复使用同一nextToken,每个独立请求必须使用唯一的nextToken。 '],
        ['code' => 'NotFound.Skill', 'message' => 'Specified skill not found.', 'http_code' => 404, 'description' => '指定的Skill不存在。'],
        ['code' => 'OperationFailed', 'message' => 'Get skill content failed.', 'http_code' => 500, 'description' => '获取Skill内容失败。'],
    ],
    'changeSet' => [],
    'flowControl' => [
        'flowControlList' => [],
    ],
];