自动化
解析运行目标
将 ns/name@tag、精确版本或版本范围解析为可运行的精确版本。
将 ns/name@tag、精确版本或版本范围解析为可运行的精确版本;省略 @ 时使用 latest,归档目标拒绝解析,无匹配返回 NO_MATCHING_VERSION。
GET /automation/v1/resolve
鉴权
Authorization: Bearer $PRAXIS_API_KEY
请求字段
| 参数 | 类型 | 说明 |
|---|---|---|
| query: target | string | 必填;ns/name@tag、ns/name@version 或 ns/name@range;省略 @ 时使用 latest。 |
示例
先设置以下环境变量,使用你自己的资源:
| 变量 | 来源 |
|---|---|
| TARGET | 已发布的 docs-samples/name@1.0.0 |
: "${TARGET:?Set TARGET}"
curl --fail-with-body -X GET "https://api.deepraxis.ai/automation/v1/resolve" \
-H "Authorization: Bearer $PRAXIS_API_KEY" \
--get \
--data-urlencode "target=${TARGET}"import { createAutomationClient } from '@deepractice-ai/praxis-sdk/automation';
function env(name: string): string {
const value = process.env[name];
if (!value) throw new Error(`Set ${name}`);
return value;
}
const automation = createAutomationClient({
apiKey: env('PRAXIS_API_KEY'),
baseUrl: 'https://api.deepraxis.ai',
maxRetries: 0,
timeoutMs: 90_000,
});
const result = await automation.resolve.retrieve({
"query": {
"target": env("TARGET")
}
});
console.log(result);响应
HTTP 200
Success
application/json
| 字段 | 类型 | 说明 |
|---|---|---|
| kind | "script" / "workflow" | 必填 / 必有;编排类型。script 为 TypeScript 脚本,一次执行;workflow 为 YAML 工作流,由步骤组成,可等待事件、定时器或子运行并可暂停。 |
| namespace | string | 必填 / 必有;编排命名空间。 |
| name | string | 必填 / 必有;编排名字。 |
| version | string | 必填 / 必有;target 解析到的精确版本号。 |
| version_id | string | 必填 / 必有;该版本的 ID(scv_ 或 wfv_ 前缀)。 |
| deprecated | null / string | 必填 / 必有;解析到的版本被弃用时的弃用说明;未弃用为 null。 |
实测响应
HTTP 200
{
"kind": "script",
"namespace": "docs-samples",
"name": "sample-scripts-1791867412840-b05e8a",
"version": "1.0.0",
"version_id": "scv_00mv67lza679fc5498438040079f0c5684208c4915",
"deprecated": null
}错误码
| HTTP | 错误码与说明 |
|---|---|
| 400 | INVALID_PARAMS:请求参数、路径、游标或请求体格式无效。 |
| 404 | TARGET_NOT_FOUND:编排目标不存在或类型不匹配。 |
| 409 | TARGET_ARCHIVED:目标已归档,不能用于本操作;动作执行错误的 detail 包含 ns/name。 |
| 422 | NO_MATCHING_VERSION:没有满足标签、版本或范围的已发布版本。 |
| default | RFC 9457 automation problem. 429 includes Retry-After. |
鉴权错误与通用错误 · 排查时保留响应头 X-Request-Id。