Use Alibaba Cloud CLI to obtain the help information - - Alibaba Cloud Dokümantasyon Merkezi

Alibaba Cloud CLI, Alibaba Cloud hizmetleri ve bunların API bilgileriyle entegredir. Yardım bilgilerini almak için Alibaba Cloud CLI'da --help seçeneğini kullanabilirsiniz.

Mevcut hizmetleri ve genel seçenekleri sorgulama

Yaygın komut seçeneklerini ve desteklenen hizmetleri sorgulamak için aliyun komutuna --help seçeneğini ekleyin.

Aşağıdaki komutu çalıştırın:
```
aliyun --help
```

Örnek yanıt (kısmi):

shell@Alicloud:~$ aliyun --help
Alibaba Cloud CLI 3.0.276

Usage:
  aliyun <product> <operation> [--parameter1 value1 --parameter2 value2 ...]

Flags:
  --mode                    Use `--mode {AK|StsToken|RamRoleArn|EcsRamRole|RsaKeyPair|RamRoleArnWithRoleName}` to specify an authentication method.
  --profile,-p              Use `--profile <profileName>` to specify a profile.
  ...
  --help                    Print the help information.

Sample:
  aliyun ecs DescribeRegions

Products:
  actiontrail                  ActionTrail
  adb                          AnalyticDB for MySQL
  adcp                         Distributed Cloud Container Platform for Kubernetes
  ...

Bir hizmet için mevcut API işlemlerini sorgulama

Hizmette mevcut olan API işlemlerinin listesini sorgulamak için hizmet kodundan sonra --help seçeneğini ekleyin. Uzak yordam çağrısı (RPC) stili API işlemlerinin açıklamaları görüntülenir. Kaynak yönelimli mimari (ROA) stili API işlemlerinin uç noktaları görüntülenir.

Not

Alibaba Cloud CLI, bir işlemin durumunu veya özelliklerini belirtmek için işlem açıklamasından önce aşağıdaki göstergeleri kullanır:

[Anonymous]: Kimlik doğrulama olmadan çağrılabilecek anonim bir işlemi belirtir. Bu tür bir işlemi çağırmak hakkında daha fazla bilgi için bkz. Genel çağrılar.
[Deprecated]: İşlemin kullanım dışı kaldığını belirtir. Bu işlemin sonraki bir sürümüne geçmeniz önerilir.

RPC

Elastic Compute Service (ECS) içindeki mevcut API işlemlerini sorgulamak için aşağıdaki komutu çalıştırın:
```
aliyun ecs --help
```

Beklenen yanıt:

shell@Alicloud:~$ aliyun ecs --help
Alibaba Cloud CLI 3.0.276

Usage:
  aliyun ecs <ApiName> --parameter1 value1 --parameter2 value2 ...

Product: Ecs (ECS)
Version: 2014-05-26 

Available Api List: 
  AcceptInquiredSystemEvent                          Accepts and authorizes operations on system events. For system events in the Inquiring state, this operation accepts the default operations for the system events and authorizes the system to perform the default operations. 
  ActivateRouterInterface                            [Deprecated] Activates inactive router interfaces. 
  AddBandwidthPackageIps                             [Deprecated]
  AddTags                                            Adds or overwrites one or more tags for ECS resources. You can add tags to ECS resources such as instances, disks, snapshots, images, and security groups for easy management. 
  ...

ROA

Container Service for Kubernetes (ACK) içindeki mevcut API işlemlerini sorgulamak için aşağıdaki komutu çalıştırın:
```
aliyun cs --help
```

Beklenen yanıt:

shell@Alicloud:~$ aliyun cs --help
Alibaba Cloud CLI 3.0.276

Usage 1:
  aliyun cs [GET|PUT|POST|DELETE] <PathPattern> --body "..." 

Usage 2 (For API with NO PARAMS in PathPattern only.):
  aliyun cs <ApiName> --parameter1 value1 --parameter2 value2 ... --body "..."

Product: CS (ACK)
Version: 2015-12-15 

Available Api List: 
  AttachInstances                         : POST /clusters/[ClusterId]/attach
  AttachInstancesToNodePool               : POST /clusters/[ClusterId]/nodepools/[NodepoolId]/attach
  CancelClusterUpgrade                    : POST /api/v2/clusters/[ClusterId]/upgrade/cancel
  CancelComponentUpgrade                  : POST /clusters/[clusterId]/components/[componentId]/cancel
  ...

API parametre ayrıntılarını sorgulama

Parametre adı ve parametre türü dahil olmak üzere parametre ayrıntılarını sorgulamak için bir API işleminden sonra --help seçeneğini ekleyin. ROA stili bir API işleminin istek yöntemi ve uç noktası da görüntülenir.

RPC

Elastic Compute Service öğesinin DescribeRegions işlemine ilişkin parametre ayrıntılarını sorgulamak için aşağıdaki komutu çalıştırın:
```
aliyun ecs DescribeRegions --help
```

Beklenen yanıt:

shell@Alicloud:~$ aliyun ecs DescribeRegions --help
Alibaba Cloud CLI 3.0.276

Product: Ecs (ECS)

Parameters:
  --AcceptLanguage String  Optional

  The natural language that is used to filter responses. For more information, see RFC7231 at https://tools.ietf.org/html/rfc7231. Valid values:   
           
  - zh-CN: Chinese 
  - en-US: English. 
  - ja: Japanses 
  
  Default value: zh-CN. 

  --InstanceChargeType String  Optional

  The billing method of the instance. For more information, see Billing overview. Valid values: 
  
  - PrePaid: subscription. If you set this parameter to PrePaid, make sure that you have sufficient balance or credits in your account. Otherwise, the InvalidPayMethod error code is returned. 
  - PostPaid: pay-as-you-go. 
  
  Default value: PostPaid. 

  --ResourceType String  Optional

  The type of the resource. Valid values:
  -  instance: ECS instance
  -  disk: disk
  -  reservedinstance: reserved instance
  -  scu: storage capacity unit (SCU)
  
  Default value: instance

ROA

Container Service for Kubernetes öğesinin AttachInstances işlemine ilişkin parametre ayrıntılarını sorgulamak için aşağıdaki komutu çalıştırın:
```
aliyun cs AttachInstances --help
```

Beklenen yanıt:

shell@Alicloud:~$ aliyun cs AttachInstances --help
Alibaba Cloud CLI 3.0.276

Product:     CS (ACK)
Method:      POST
PathPattern: /clusters/[ClusterId]/attach

Parameters:
  --ClusterId String  Required

  The ID of the cluster. 

  --body Struct  Optional

  The request body parameters.