Alibaba Cloud CLI を使用して RPC および ROA API 操作を呼び出す - Alibaba Cloud CLI

このトピックでは、一般的な Alibaba Cloud CLI コマンドの構文と、リモートプロシージャコール ( RPC) またはリソース指向アーキテクチャ ( ROA) スタイルの API 操作のコマンド構文について説明します。

一般的なコマンドの構文

Alibaba Cloud CLI では、次の構文を使用して一般的なコマンドを実行できます。

aliyun <Command> [SubCommand] [Options and Parameters]

Command: トップレベルのコマンド。
- ecs や rds など、Alibaba Cloud CLI でサポートされている Alibaba Cloud サービスのコードを指定できます。
- configure などの Alibaba Cloud CLI コマンドを指定することもできます。

SubCommand: 実行する操作。
- トップレベルの command が configure に設定されている場合は、「プロファイル関連のコマンド」トピックで説明されている操作がサポートされます。
- トップレベルの command が Alibaba Cloud サービスのコードに設定されており、操作が RPC スタイルの場合は、実行する操作の名前を指定できます。

Options and Parameters: Alibaba Cloud CLI のアクションを指定するために使用されるオプションまたはパラメーター。数字、文字列、または JSON 文字列を指定できます。詳細については、「パラメーターの形式」をご参照ください。

API スタイルを確認する

Alibaba Cloud サービスの API は、RPC と ROA の 2 つのスタイルに分類されます。ほとんどのサービスは RPC スタイルを使用しています。Alibaba Cloud CLI を使用して API 操作を呼び出すときは、呼び出し方法が API スタイルによって異なるため、操作のスタイルを判断する必要があります。API 操作のスタイルを判断する方法は次のとおりです。

API を呼び出す Alibaba Cloud サービスのドキュメントに移動し、[関数別の操作一覧]開発リファレンス の章のトピックで API スタイルを確認します。
コマンドで API を呼び出す Alibaba Cloud サービスのコードに --help を追加して、Alibaba Cloud サービスの API 操作を取得します。コマンドの出力は、API 操作スタイルによって異なります。
- 簡単な説明が返された場合、API スタイルは RPC です。
- リクエストパスを示す PathPattern パラメーターが返された場合、API スタイルは ROA です。
詳細については、「help コマンドを使用する」をご参照ください。
コマンドの API 操作名 に --help を追加して、API 操作のパラメーターを取得します。API 操作のパラメーターに加えて、Method パラメーターと PathPattern パラメーターが返された場合、API スタイルは ROA です。詳細については、「help コマンドを使用する」トピックの「API 操作のパラメーターを照会する」セクションをご参照ください。

ほとんどの場合、サービスのすべての API 操作は同じ API スタイルを使用します。各 API は 1 つのスタイルのみをサポートします。RPC スタイルと ROA スタイルの詳細については、「API スタイル」をご参照ください。

RPC スタイルの API 操作を呼び出す

構文

Alibaba Cloud CLI を使用して RPC スタイルの API 操作を呼び出すコマンドを実行するには、次の構文を使用できます。

aliyun <ProductCode> <APIName> [Parameters]

ProductCode: API を呼び出す Alibaba Cloud サービスのコード。たとえば、Elastic Compute Service (ECS) のコードは ecs です。
APIName: 呼び出したい API 操作の名前。たとえば、DescribeRegions 操作を Elastic Compute Service で呼び出すことができます。
Parameters: API 操作のリクエストパラメーター。各 Alibaba Cloud サービスの API リファレンスでリクエストパラメーターの詳細を確認し、パラメーターをオプションとして指定できます。
--help コマンドを使用して、上記のパラメーターに関するヘルプ情報を取得できます。詳細については、「help コマンドを使用する」をご参照ください。

例

この例では、ECS の DescribeRegions 操作を呼び出す方法を示します。デフォルトでは、ECS の最近のリージョンリストが照会されます。詳細については、「DescribeRegions」をご参照ください。
```
aliyun ecs DescribeRegions
```
この例では、ECS の DescribeInstanceAttribute 操作を呼び出す方法を示します。ECS インスタンスの属性が照会されます。詳細については、「DescribeInstanceAttribute」をご参照ください。
```
aliyun rds DescribeInstanceAttribute --InstanceId 'i-uf6f5trc95ug8t33****'
```

ROA スタイルの API 操作を呼び出す

構文

Alibaba Cloud CLI を使用して ROA スタイルの API 操作を呼び出すコマンドを実行するには、次の構文を使用できます。

 aliyun <ProductCode> <Method> <PathPattern> [RequestBody] [Parameters]

ProductCode: API を呼び出す Alibaba Cloud サービスのコード。たとえば、Container Service for Kubernetes (ACK) のコードは cs です。
Method: リクエストメソッド。API リファレンスに基づいて適切なリクエストメソッドを選択できます。一般的なリクエストメソッドには、GET、PUT、POST、DELETE などがあります。
PathPattern: リクエストパス。API リファレンスに基づいて有効なリクエストパスを指定できます。
RequestBody: リクエスト本文。API リファレンスに基づいて、次のオプションのいずれかを使用してリクエスト本文を指定できます。
- --body オプションを使用して、文字列または変数をリクエスト本文として指定します。
- --body-file オプションを使用してファイルパスを指定します。ファイルはリクエスト本文として使用されます。
詳細については、「API 呼び出しのコマンドラインオプション」をご参照ください。
Parameters: API 操作のリクエストパラメーター。API リファレンスでリクエストパラメーターの詳細を確認し、パラメーターをオプションとして指定できます。
--help オプションを使用して、上記のパラメーターに関するヘルプ情報を取得できます。詳細については、「help コマンドを使用する」をご参照ください。

例

GET リクエスト

この例では、ACK の DescribeClustersForRegion 操作を呼び出して、中国 (杭州) リージョンにある ACK 専用クラスターを照会する方法を示します。詳細については、「DescribeClustersForRegion」をご参照ください。

aliyun cs GET /regions/cn-hangzhou/clusters --cluster_type Kubernetes

PUT リクエスト

この例では、ACK の ModifyCluster 操作を呼び出して、クラスターに関連付けられているエラスティック IP アドレス ( EIP) を変更する方法を示します。詳細については、「ModifyCluster」をご参照ください。

aliyun cs PUT /api/v2/clusters/cb95aa626a47740afbf6aa099b65**** --body "{\"api_server_eip\":true,\"api_server_eip_id\":\"eip-wz9fnasl6dsfhmvci****\"}"

POST リクエスト

この例では、ACK の CreateCluster 操作を呼び出して、create.json ファイルを使用して ACK 専用クラスターを作成する方法を示します。詳細については、「CreateCluster」をご参照ください。

aliyun cs POST /clusters --body-file create.json

JSON ファイルのサンプルコード

{
    "cluster_type":"Kubernetes",
    "name":"webService",
    "region_id":"cn-beijing",
    "disable_rollback":true,
    "timeout_mins":60,
    "kubernetes_version":"1.14.8-aliyun.1",
    "snat_entry":true,
    "endpoint_public_access":true,
    "ssh_flags":true,
    "cloud_monitor_flags":true,
    "deletion_protection":false,
    "node_cidr_mask":"26",
    "proxy_mode":"ipvs",
    "tags":[],
    "addons":[{"name":"flannel"},{"name":"arms-prometheus"},{"name":"flexvolume"},{"name":"alicloud-disk-controller"},{"name":"logtail-ds","config":"{"IngressDashboardEnabled":"false"}"},{"name":"ack-node-problem-detector","config":"{"sls_project_name":""}"},{"name":"nginx-ingress-controller","config":"{"IngressSlbNetworkType":"internet"}"}],
    "os_type":"Linux",
    "platform":"CentOS",
    "node_port_range":"30000-32767",
    "key_pair":"sian-sshkey",
    "cpu_policy":"none",
    "master_count":3,
    "master_vswitch_ids":["vsw-2zete8s4qocqg0mf6****","vsw-2zete8s4qocqg0mf6****","vsw-2zete8s4qocqg0mf6****"],
    "master_instance_types":["ecs.n4.large","ecs.n4.large","ecs.n4.large"],
    "master_system_disk_category":"cloud_ssd",
    "master_system_disk_size":120,
    "runtime":{"name":"docker","version":"18.09.2"},
    "worker_instance_types":["ecs.i1.xlarge"],
    "num_of_nodes":1,
    "worker_system_disk_category":"cloud_efficiency",
    "worker_system_disk_size":120,
    "vpcid":"vpc-2zecuu62b9zw7a7q****",
    "worker_vswitch_ids":["vsw-2zete8s4qocqg0mf6****"],
    "container_cidr":"172.20.0.0/16",
    "service_cidr":"172.21.0.0/20"
}

DELETE リクエスト

この例では、ACK の DeleteClusterNodepool 操作を呼び出して、クラスターから指定されたノードプールを削除する方法を示します。詳細については、「DeleteClusterNodepool」をご参照ください。

aliyun cs DELETE /clusters/cb95aa626a47740afbf6aa099b65****/nodepools/np30db56bcac7843dca90b999c8928****