

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 的 CloudWatch Logs 範例 AWS CLI
<a name="cli_cloudwatch-logs_code_examples"></a>

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 CloudWatch Logs 執行動作和實作常見案例。

*Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。

**Topics**
+ [動作](#actions)

## 動作
<a name="actions"></a>

### `create-log-group`
<a name="cloudwatch-logs_CreateLogGroup_cli_topic"></a>

以下程式碼範例顯示如何使用 `create-log-group`。

**AWS CLI**  
以下命令會建立名為 `my-logs` 的日誌群組：  

```
aws logs create-log-group --log-group-name my-logs
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateLogGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/create-log-group.html)。

### `create-log-stream`
<a name="cloudwatch-logs_CreateLogStream_cli_topic"></a>

以下程式碼範例顯示如何使用 `create-log-stream`。

**AWS CLI**  
以下範例會在日誌群組 `my-logs` 中建立名為 `20150601` 的日誌串流。  

```
aws logs create-log-stream --log-group-name my-logs --log-stream-name 20150601
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateLogStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/create-log-stream.html)。

### `delete-log-group`
<a name="cloudwatch-logs_DeleteLogGroup_cli_topic"></a>

以下程式碼範例顯示如何使用 `delete-log-group`。

**AWS CLI**  
下列命令會刪除名為 `my-logs` 的日誌群組：  

```
aws logs delete-log-group --log-group-name my-logs
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteLogGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-log-group.html)。

### `delete-log-stream`
<a name="cloudwatch-logs_DeleteLogStream_cli_topic"></a>

以下程式碼範例顯示如何使用 `delete-log-stream`。

**AWS CLI**  
下列命令從名為 `my-logs` 的日誌群組中刪除名為 `20150531` 的日誌串流：  

```
aws logs delete-log-stream --log-group-name my-logs --log-stream-name 20150531
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteLogStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-log-stream.html)。

### `delete-retention-policy`
<a name="cloudwatch-logs_DeleteRetentionPolicy_cli_topic"></a>

以下程式碼範例顯示如何使用 `delete-retention-policy`。

**AWS CLI**  
下列命令會移除先前套用至日誌群組 `my-logs` 的保留政策：  

```
aws logs delete-retention-policy --log-group-name my-logs
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteRetentionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-retention-policy.html)。

### `describe-log-groups`
<a name="cloudwatch-logs_DescribeLogGroups_cli_topic"></a>

以下程式碼範例顯示如何使用 `describe-log-groups`。

**AWS CLI**  
下列命令描述名為 `my-logs` 日誌群組：  

```
aws logs describe-log-groups --log-group-name-prefix my-logs
```
輸出：  

```
{
    "logGroups": [
        {
            "storedBytes": 0,
            "metricFilterCount": 0,
            "creationTime": 1433189500783,
            "logGroupName": "my-logs",
            "retentionInDays": 5,
            "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:*"
        }
    ]
}
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeLogGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/describe-log-groups.html)。

### `describe-log-streams`
<a name="cloudwatch-logs_DescribeLogStreams_cli_topic"></a>

以下程式碼範例顯示如何使用 `describe-log-streams`。

**AWS CLI**  
下列命令顯示日誌群組 `my-logs`中以 `2015` 開頭的所有日誌串流：  

```
aws logs describe-log-streams --log-group-name my-logs --log-stream-name-prefix 2015
```
輸出：  

```
{
    "logStreams": [
        {
            "creationTime": 1433189871774,
            "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150531",
            "logStreamName": "20150531",
            "storedBytes": 0
        },
        {
            "creationTime": 1433189873898,
            "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150601",
            "logStreamName": "20150601",
            "storedBytes": 0
        }
    ]
}
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeLogStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/describe-log-streams.html)。

### `get-log-events`
<a name="cloudwatch-logs_GetLogEvents_cli_topic"></a>

以下程式碼範例顯示如何使用 `get-log-events`。

**AWS CLI**  
下列命令會從日誌群組 `my-logs` 中名為 `20150601` 的日誌串流擷取日誌事件：  

```
aws logs get-log-events --log-group-name my-logs --log-stream-name 20150601
```
輸出：  

```
{
    "nextForwardToken": "f/31961209122447488583055879464742346735121166569214640130",
    "events": [
        {
            "ingestionTime": 1433190494190,
            "timestamp": 1433190184356,
            "message": "Example Event 1"
        },
        {
            "ingestionTime": 1433190516679,
            "timestamp": 1433190184356,
            "message": "Example Event 1"
        },
        {
            "ingestionTime": 1433190494190,
            "timestamp": 1433190184358,
            "message": "Example Event 2"
        }
    ],
    "nextBackwardToken": "b/31961209122358285602261756944988674324553373268216709120"
}
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetLogEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/get-log-events.html)。

### `put-log-events`
<a name="cloudwatch-logs_PutLogEvents_cli_topic"></a>

以下程式碼範例顯示如何使用 `put-log-events`。

**AWS CLI**  
下列命令將日誌事件放入日誌群組 `my-logs` 中名為 `20150601` 的日誌串流：  

```
aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events
```
輸出：  

```
{
    "nextSequenceToken": "49542672486831074009579604567656788214806863282469607346"
}
```
上述範例從目前目錄中名為 `events` 的檔案讀取事件的 JSON 陣列：  

```
[
  {
    "timestamp": 1433190184356,
    "message": "Example Event 1"
  },
  {
    "timestamp": 1433190184358,
    "message": "Example Event 2"
  },
  {
    "timestamp": 1433190184360,
    "message": "Example Event 3"
  }
]
```
每個後續呼叫都需要使用序列字符選項來指定的前一個呼叫，藉此提供下一個序列字符：  

```
aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events2 --sequence-token "49542672486831074009579604567656788214806863282469607346"
```
輸出：  

```
{
    "nextSequenceToken": "49542672486831074009579604567900991230369019956308219826"
}
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutLogEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/put-log-events.html)。

### `put-retention-policy`
<a name="cloudwatch-logs_PutRetentionPolicy_cli_topic"></a>

以下程式碼範例顯示如何使用 `put-retention-policy`。

**AWS CLI**  
下列命令會將 5 天保留政策新增至名為 `my-logs` 的日誌群組：  

```
aws logs put-retention-policy --log-group-name my-logs --retention-in-days 5
```
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutRetentionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/put-retention-policy.html)。