

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 获取跑步信息
<a name="getinfo-about-runs"></a>

开始运行后，您可以使用 API 检索其状态、配置和任务级别的 HealthOmics 详细信息。本页介绍如何：

**Topics**
+ [获取运行状态和详细信息](#get-run)
+ [列出所有跑步](#list-runs)
+ [列出运行中的任务](#list-tasks)
+ [获取任务详情](#get-task)
+ [在中运行元数据 CloudWatch](#run-metadata)

## 获取运行状态和详细信息
<a name="get-run"></a>

使用 **GetRun** API 操作检查状态并检索特定运行的详细信息。您需要运行 ID，它会在您开始运行时返回。

```
aws omics get-run --id {{run_id}}
```

**查找运行 ID**  
您可以通过以下方式找到运行 ID：  
来自 [**StartRun**API 响应](starting-a-run.md#start-run-api-basic) — 开始运行时会返回该`id`字段。
在 HealthOmics 控制台中 — 在 “**运行**” 页面上，运行 ID 显示在运行列表的第一列中。
来自 **ListRuns** API — 列出您账户中的所有跑步及其ID。

响应包括运行状态、工作流程详细信息、加速器信息和时间戳。可能的运行状态为：


| Status | 说明 | 
| --- | --- | 
| PENDING | 运行已提交，正在等待开始。 | 
| STARTING | HealthOmics 正在为运行配置资源。 | 
| RUNNING | 运行正在积极执行任务。 | 
| COMPLETED | 运行成功完成。输出文件位于 Amazon S3 的输出位置。 | 
| FAILED | 运行时遇到了错误。请参阅[运行失败原因](workflows-run-errors.md)。 | 
| CANCELLED | 该用户取消了运行。 | 

运行时`COMPLETED`，您可以在 Amazon S3 输出存储桶中找到输出文件，该文件位于以运行 ID 命名的文件夹中。

### 响应示例
<a name="get-run-example-response"></a>

以下示例显示了使用 GPU 加速器完成私有 WDL 工作流运行后的响应：

```
{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/7830534",
    "id": "7830534",
    "uuid": "96c57683-74bf-9d6d-ae7e-f09b097db14a",
    "outputUri": "s3://amzn-s3-demo-bucket/output",
    "status": "COMPLETED",
    "workflowId": "4074992",
    "workflowType": "PRIVATE",
    "workflowVersionName": "3.0.0",
    "roleArn": "arn:aws:iam::123456789012:role/OmicsRole",
    "name": "RunGroupMaxGpuTest",
    "runGroupId": "9938959",
    "digest": "sha256:a23a6fc54040d36784206234c02147302ab8658bed89860a...",
    "accelerators": "GPU",
    "startedBy": "arn:aws:sts::123456789012:assumed-role/Admin/role_name",
    "creationTime": "2023-04-07T16:44:22.262471+00:00",
    "startTime": "2023-04-07T16:56:12.504000+00:00",
    "stopTime": "2023-04-07T17:22:29.908813+00:00",
    "tags": {}
}
```

### 响应中的关键字段
<a name="get-run-key-fields"></a>


| 字段 | 说明 | 
| --- | --- | 
| uuid | 运行的通用唯一标识符。除此之外outputUri，还可用于跟踪输出数据的写入位置。 | 
| status | 当前运行状态（参见上表）。 | 
| workflowType | 工作流程是还PRIVATE是READY2RUN。 | 
| accelerators | 使用的加速器类型（例如，GPU）（如果适用）。 | 
| digest | SHA-256 工作流程定义摘要。 | 
| creationTime | 提交跑步的时间。 | 
| startTime | 运行何时开始执行。 | 
| stopTime | 当运行结束或被取消时。 | 
| engineSettings | 应用于运行的引擎设置。仅对于 Nextflow 工作流程，才会返回此字段。如果您为 WDL 或 CWL 工作流程指定引擎设置，则这些设置将被静默忽略，并且响应中不存在此字段。GetRun请参阅[指定下一流引擎设置](starting-a-run.md#start-run-api-engine-settings)。 | 

### 使用引擎设置运行 Nextflow 的响应示例
<a name="get-run-engine-settings-example"></a>

对于使用引擎设置启动的 Nextflow 运行，**GetRun**响应中包含一张反映应用于运行的值的`engineSettings`地图。以下示例显示了从固定的引擎版本和两个配置文件开始的运行。

```
{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/9876543",
    "id": "9876543",
    "uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status": "COMPLETED",
    "workflowId": "1122334",
    "workflowType": "PRIVATE",
    "workflowVersionName": "1.2.1",
    "roleArn": "arn:aws:iam::123456789012:role/OmicsRole",
    "name": "nextflow-rnaseq-run",
    "outputUri": "s3://amzn-s3-demo-bucket/output",
    "engineSettings": {
        "engineVersion": "26.04",
        "profile": "test,docker"
    },
    "creationTime": "2024-09-10T16:44:22.262471+00:00",
    "startTime": "2024-09-10T16:56:12.504000+00:00",
    "stopTime": "2024-09-10T17:22:29.908813+00:00",
    "tags": {}
}
```

该`engineSettings`字段仅针对 Nextflow 工作流程返回。对于 WDL 和 CWL 工作流程，响应中不存在此字段。有关更多信息，请参阅 [指定下一流引擎设置](starting-a-run.md#start-run-api-engine-settings)。

## 列出所有跑步
<a name="list-runs"></a>

使用 **ListRuns** API 操作查看您账户中的所有运行情况：

```
aws omics list-runs
```

响应返回分页的运行列表，其中包含运行ID、名称、状态和时间戳等摘要信息。使用`--starting-token`参数检索其他页面。

## 列出运行中的任务
<a name="list-tasks"></a>

使用 **ListRunTasks** API 操作查看特定运行中完成的所有任务：

```
aws omics list-run-tasks --id {{run_id}}
```

响应会返回任务列表，其中包含其状态、资源分配和计时信息。

## 获取任务详情
<a name="get-task"></a>

使用 **GetRunTask** API 操作获取有关运行中特定任务的详细信息：

```
aws omics get-run-task --id {{run_id}} --task-id {{task_id}}
```

响应包括任务级别的详细信息，例如 CPU、内存分配、容器映像和任务状态。

## 在中运行元数据 CloudWatch
<a name="run-metadata"></a>

运行完成后， HealthOmics 将运行元数据发送到流下 CloudWatch 的 Logs：

```
manifest/run/{{run_id}}/{{run_uuid}}
```

清单包括完整的运行配置、输入参数、资源摘要和任务级别的详细信息。以下是清单的示例：

```
[
  {
    "arn": "arn:aws:omics:us-east-1:123456789012:run/1695324",
    "creationTime": "2022-08-24T19:53:55.284Z",
    "resourceDigests": {
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.dict": "etag:3884c62eb0e53fa92459ed9bff133ae6",
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta": "etag:e307d81c605fb91b7720a08f00276842-388",
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta.fai": "etag:f76371b113734a56cde236bc0372de0a",
      "s3://omics-data/intervals/hg38-mjs-whole-chr.500M.intervals": "etag:27fdd1341246896721ec49a46a575334",
      "s3://omics-data/workflow-input-lists/dragen-gvcf-list.txt": "etag:e22f5aeed0b350a66696d8ffae453227"
    },
    "digest": "sha256:a5baaff84dd54085eb03f78766b0a367e93439486bc3f67de42bb38b93304964",
    "engine": "WDL",
    "main": "gatk4-basic-joint-genotyping-v2.wdl",
    "name": "1044-gvcfs",
    "outputUri": "s3://omics-data/workflow-output",
    "parameters": {
      "callset_name": "cohort",
      "input_gvcf_uris": "s3://omics-data/workflow-input-lists/dragen-gvcf-list.txt",
      "interval_list": "s3://omics-data/intervals/hg38-mjs-whole-chr.500M.intervals",
      "ref_dict": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.dict",
      "ref_fasta": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta",
      "ref_fasta_index": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta.fai"
    },
    "roleArn": "arn:aws:iam::123456789012:role/OmicsServiceRole",
    "startedBy": "arn:aws:sts::123456789012:assumed-role/admin/ahenroid-Isengard",
    "startTime": "2022-08-24T20:08:22.582Z",
    "status": "COMPLETED",
    "stopTime": "2022-08-24T20:08:22.582Z",
    "storageCapacity": 9600,
    "uuid": "a3b0ca7e-9597-4ecc-94a4-6ed45481aeab",
    "workflow": "arn:aws:omics:us-east-1:123456789012:workflow/1558364",
    "workflowType": "PRIVATE"
  },
  {
    "arn": "arn:aws:omics:us-east-1:123456789012:task/1245938",
    "cpus": 16,
    "creationTime": "2022-08-24T20:06:32.971290",
    "image": "123456789012.dkr.ecr.us-west-2.amazonaws.com/gatk",
    "imageDigest": "sha256:8051adab0ff725e7e9c2af5997680346f3c3799b2df3785dd51d4abdd3da747b",
    "memory": 32,
    "name": "geno-123",
    "run": "arn:aws:omics:us-east-1:123456789012:run/1695324",
    "startTime": "2022-08-24T20:08:22.278Z",
    "status": "SUCCESS",
    "stopTime": "2022-08-24T20:08:22.278Z",
    "uuid": "44c1a30a-4eee-426d-88ea-1af403858f76"
  },
  ...
]
```

有关中可用于 HealthOmics 运行 CloudWatch 的日志的更多信息，请参阅[HealthOmics 使用 CloudWatch 日志进行监控](monitoring-cloudwatch-logs.md)。

**注意**  
即使您从 CloudWatch 日志中删除了运行元数据，也不会从日志中删除运行元数据 HealthOmics。您可以使用 CloudWatch 访问不再通过 HealthOmics API 提供的运行的元数据。