Alibaba Cloud CLI のさまざまなデータ型の形式要件 - Alibaba Cloud CLI

このトピックでは、Alibaba Cloud CLI に入力するさまざまなデータ型のパラメーターの形式要件について説明します。

パラメーター形式の要件

説明

Alibaba Cloud CLI は、OpenAPI Explorer によって自動的に生成されたサンプルコードを提供します。詳細については、「CLI コマンドの生成と実行」をご参照ください。

デフォルトでは、OpenAPI Explorer によって自動的に生成されるサンプルコードは Linux に適用可能なパラメーター形式を使用します。他の環境で CLI コマンドを実行する必要がある場合は、それに応じてパラメーター形式を調整してください。

API 操作におけるさまざまなデータ型のパラメーターの場合、Alibaba Cloud CLI にパラメーター名と値を入力する際に、以下の形式要件を満たす必要があります。

パラメーター名の大文字と小文字の区別

API 操作のパラメーター名は大文字と小文字が区別されます。 Alibaba Cloud CLI にパラメーター名を入力する際は、パラメーター名の大文字と小文字の規則に従う必要があります。

パラメーター値の大文字と小文字の区別

API 操作の一部のパラメーターの値は大文字と小文字が区別されません。ただし、一貫した記述スタイルを確保するために、パラメーター値を入力する際は、パラメーター値の大文字と小文字の規則に従うことをお勧めします。

INTEGER 型のパラメーター値

INTEGER 型の値は、パラメーターに直接記述できます。

aliyun ecs DescribeImages --ImageName Example_Image --Pagesize 10

API ドキュメントにおける STRING 型のパラメーター値

STRING 型の値にドル記号 ($)、グレイブアクセント (`)、バックスラッシュ (\)、スペース文字などの特殊文字が含まれていない場合は、パラメーターに直接記述できます。 STRING 型の値に特殊文字が含まれている場合は、値を入力する際に、値を一重引用符 (' ') または二重引用符 (" ") で囲みます。

一般的なシナリオ
Alibaba Cloud CLI は、文字列をパラメーターとして受け取ると、文字列内の特殊文字を共通文字に変換します。 Linux、macOS、または Windows PowerShell では、一重引用符 (' ') を使用してパラメーターを囲みます。 Windows シェルでは、二重引用符 (" ") を使用してパラメーターを囲みます。
- 特殊文字なし:
```
aliyun ecs DescribeImages --ImageName Example_Image
```
- 特殊文字あり:
  - Windows コマンドプロンプト:
```
aliyun ecs DescribeImages --ImageName "Example Image"
```
  - Linux、macOS、および Windows PowerShell:
```
aliyun ecs DescribeImages --ImageName 'Example Image'
```
特別なシナリオ
ROA スタイルの API 操作を呼び出す際に、--body オプションを使用してエスケープ文字または変数を含む文字列をリクエストボディとして指定する必要がある場合、引用符の使い方は一般的なシナリオとは異なります。 Linux、macOS、および Windows コマンドプロンプトでは、二重引用符 (" ") を使用してパラメーターを囲みます。 Windows PowerShell では、一重引用符 (' ') を使用してパラメーターを囲みます。
- Windows コマンドプロンプト、Linux、および macOS:
```
aliyun cs PUT /clusters/<ClusterId>/nodepools/<NodepoolId> --body "{\"nodepool_info\":{\"name\":\"default-nodepool\",\"resource_group_id\":\"rg-acfmyvw****\"}}"
```
- Windows PowerShell:
```
aliyun cs PUT /clusters/<ClusterId>/nodepools/<NodepoolId> --body '{\"nodepool_info\":{\"name\":\"default-nodepool\",\"resource_group_id\":\"rg-acfmyvw****\"}}'
```

STRING 型のリスト

STRING 型のパラメーターが ImageId など複数の値をサポートしている場合は、値をカンマ (,) で区切り、値を入力する際に一重引用符 (' ') または二重引用符 (" ") で囲みます。

Windows コマンドプロンプト:
Windows コマンドプロンプトでは、値をカンマ (,) で区切り、二重引用符 (" ") で囲みます。
```
aliyun ecs DescribeImages --ImageId "m-23e0o****,m-23wae****"
```
Linux、macOS、および Windows PowerShell:
Linux、macOS、および Windows PowerShell では、値をカンマ (,) で区切り、一重引用符 (' ') で囲みます。
```
aliyun ecs DescribeImages --ImageId 'm-23e0o****,m-23wae****'
```

STRING 型の JSON 配列

STRING 型のパラメーターをフォーマット済み JSON 配列に設定するには、次の形式で値を記述します。

Windows:
Windows コマンドプロンプトと PowerShell では、配列を角かっこ ([ ]) で囲み、角かっこ ([ ]) を二重引用符 (" ") で囲みます。角かっこ ([ ]) 内では、配列内の値をカンマ (,) で区切り、各値を一重引用符 (' ') で囲みます。
```
aliyun ecs DescribeDisks --DiskIds "['d-23rss****','d-23vsi****','d-23sfq****']"
```
Linux および macOS:
Linux および macOS では、配列を角かっこ ([ ]) で囲み、角かっこ ([ ]) を一重引用符 (' ') で囲みます。角かっこ ([ ]) 内では、配列内の値をカンマ (,) で区切り、各値を二重引用符 (" ") で囲みます。
```
aliyun ecs DescribeDisks --DiskIds '["d-23rss****","d-23vsi****","d-23sfq****"]'
```

STRING 型の JSON 配列リスト

STRING 型のパラメーターを JSON 配列リストに設定するには、次の形式で値を記述します。

Windows:
Windows コマンドプロンプトと Windows コマンドプロンプトでは、リストを角かっこ ([ ]) で囲み、角かっこ ([ ]) を二重引用符 (" ") で囲みます。角かっこ ([ ]) 内では、配列をカンマ (,) で区切り、各配列を中かっこ ({ }) で囲みます。各中かっこ ({ }) のペア内では、配列のキーと値をコロン (:) で区切り、配列のキーと値を一重引用符 (' ') で囲みます。
```
aliyun slb AddBackendServers --LoadBalancerId 15157b19f18-cn-hangzhou-dg**** --BackendServers "[{'ServerId':'i-23g8a****'},{'ServerId':'i-23bb0****'}]"
```
Linux および macOS:
Linux および macOS では、リストを角かっこ ([ ]) で囲み、角かっこ ([ ]) を一重引用符 (' ') で囲みます。角かっこ ([ ]) 内では、配列をカンマ (,) で区切り、各配列を中かっこ ({ }) で囲みます。各中かっこ ({ }) のペア内では、配列のキーと値をコロン (:) で区切り、配列のキーと値を二重引用符 (" ") で囲みます。
```
aliyun slb AddBackendServers --LoadBalancerId 15157b19f18-cn-hangzhou-dg**** --BackendServers '[{"ServerId":"i-23g8a****"},{"ServerId":"i-23bb0****"}]'
```

STRING 型の DateTime 値

STRING 型のパラメーターを ISO 8601 標準の UTC タイムスタンプに設定するには、YYYY-MM-DDThh:mm:ssZ 形式でパラメーター値を入力します。

aliyun ecs DescribeInstanceMonitorData --InstanceId i-94ola4btx**** --StartTime 2015-11-28T15:00:00Z --EndTime 2015-11-28T18:00:00Z

特殊文字

特殊文字を含むパラメーター値を入力すると、値を引用符で囲んでも解析エラーが発生する場合があります。この問題を解決するには、key=value 形式でパラメーター値を入力します。

例

次のコマンドでは、Alibaba Cloud CLI は -1/-1 を PortRange の値として認識できません。

aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange "-1/-1" --method POST --force

この問題を解決するには、次のコードブロックに示すように、--PortRange -1/-1 を --PortRange=-1/-1 に置き換えます。

aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange=-1/-1 --method POST --force