Use common parameters to obtain information about Alibaba Cloud regions, zones, and cloud products - CloudOps Orchestration Service

CloudOps Orchestration Service (OOS) common parameters are managed and maintained by Alibaba Cloud. You can use common parameters to obtain information about Alibaba Cloud regions, zones, cloud services, and endpoints.

Prerequisites

Alibaba Cloud CLI is installed and configured. If Alibaba Cloud CLI is not installed or configured, see:

Note

If you only need to perform temporary debugging operations, you do not need to install Alibaba Cloud CLI. You can use Cloud Shell provided by Alibaba Cloud to obtain information about cloud service hosts.

Install Alibaba Cloud CLI.
Configure Alibaba Cloud CLI.
Configure parameters, such as credentials and regions, that are required to use Alibaba Cloud resources. For more information about how to configure the information, see Identity credential types.

Procedure

Obtain the information about Alibaba Cloud regions

All regions

Request command
You can run the following command on Alibaba Cloud CLI to call the GetParametersByPath operation and use the common parameter path to quickly query all Alibaba Cloud regions.
```
aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/regions
```
Path specifies the path of the parameter to be obtained. In this scenario, the path is set to aliyun/services/global-infrastructure/regions, which indicates that the request obtains the information about all regions.

Sample success responses

The sample responses include the region IDs and names, creation time, update time, and other information. Only some regions are displayed, such as cn-hangzhou and cn-shanghai.

Example: cn-hangzhou and cn-shanghai region information

{
 "MaxResults": 10,
 "Parameters": [
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/regions/cn-hangzhou",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "cn-hangzhou"
 },
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/regions/cn-shanghai",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "cn-shanghai"
 }
 ],
 "RequestId": "xxxxxxxxxxxxxx"
}

Regions supported by a service

Request command
You can run the following command on Alibaba Cloud CLI to call the GetParametersByPath operation and use the common parameter path to quickly query the regions supported by an Alibaba Cloud service.
```
aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/products/oos/regions
```
The Path specifies the path of the parameter to be obtained. In this scenario, the path is set to aliyun/services/global-infrastructure/products/{product_code}/regions. Set {product_code} to the code of a specific service, such as oos .

Sample success responses

The sample responses include the region IDs and names, creation time, update time, and other information. Only some regions are displayed. For example, OOS is supported by cn-hangzhou and cn-shanghai.

Example: Regions supported by OOS

{
 "MaxResults": 10,
 "Parameters": [
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/products/oos/regions/cn-hangzhou",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "cn-hangzhou"
 },
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/products/oos/regions/cn-shanghai",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "cn-shanghai"
 }
 ],
 "RequestId": "xxxxxxxxxxxxxx"
}

Query all Alibaba Cloud zones

Request command
You can run the following command on Alibaba Cloud CLI to call the GetParametersByPath operation and use the common parameter path to query all Alibaba Cloud zones.
```
aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/availability-zones
```
Set Path to the parameter path to be obtained. In this scenario, the path is set to aliyun/services/global-infrastructure/availability-zones, which indicates that the request queries all zones.

Sample success responses

The sample responses include the zone IDs and names, creation time, update time, and other information. Only some zones are displayed, such as cn-shanghai-g-alipay and cn-shanghai-x6.

Example: cn-shanghai-g-alipay and cn-shanghai-x6 zone information

{
 "MaxResults": 10,
 "Parameters": [
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/availability-zones/cn-shanghai-g-alipay",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "cn-shanghai-g-alipay"
 },
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/availability-zones/cn-shanghai-x6",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "cn-shanghai-x6"
 }
 ],
 "RequestId": "xxxxxxxxxxxxxx"
}

Query Alibaba Cloud services

Request command
You can run the following command on Alibaba Cloud CLI to call the GetParametersByPath operation and use the common parameter path to query Alibaba Cloud services.
```
aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/products
```
Set Path to the parameter path to be obtained. In this scenario, the path is set to aliyun/services/global-infrastructure/products, which indicates that the request queries all zones.

Sample success responses

The sample responses include the service IDs and names, creation time, update time, and other information. Only some cloud products are displayed, such as OOS and ECS.

Example: OOS and ECS information

{
 "MaxResults": 10,
 "Parameters": [
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/products/oos",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "oos"
 },
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/products/ecs",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "ecs"
 }
 ],
 "RequestId": "xxxxxxxxxxxxxx"
}

Query the endpoint of a service

Request command
You can run the following command on Alibaba Cloud CLI to call the GetParametersByPath operation and use the common parameter path to query the endpoint of an Alibaba Cloud service.
```
aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/products/oos/endpoints
```
Set Path to the parameter path to be obtained. In this scenario, the path is set to aliyun/services/global-infrastructure/products/{product_code}/endpoints, in which {product_code} is the code of a specific service, such as oos .

Sample success responses

The sample responses include the endpoint IDs and names, creation time, update time, and other information. Only the endpoints of OOS in some regions are displayed. For example, you can obtain the endpoints of OOS in cn-hangzhou and cn-shanghai.

Example: OOS endpoints in some regions

{
 "MaxResults": 10,
 "Parameters": [
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/products/oos/endpoints/endpoint-cn-hangzhou",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "oos.cn-hangzhou.aliyuncs.com"
 },
 {
 "Id": "p-xxxxxx",
 "Name": "aliyun/services/global-infrastructure/products/oos/endpoints/endpoint-cn-shanghai",
 "CreatedDate": "2023-05-17T06:21:15Z",
 "UpdatedDate": "2023-05-17T06:21:15Z",
 "Value": "oos.cn-shanghai.aliyuncs.com"
 }
 ],
 "RequestId": "xxxxxxxxxxxxxx"
}