通过公共参数获取阿里云地域、可用区及云产品相关信息

更新时间:2025-03-06 06:29:03

相比普通参数由您自己创建和管理,OOS提供的公共参数由阿里云统一管理和维护,您可以直接使用公共参数快速获取阿里云的地域(所有地域或某个产品支持的地域)、可用区、云产品以及云产品的Endpoint相关信息。

准备工作

已安装并配置阿里云CLI。如未安装或配置阿里云CLI,请参见:

说明

如果您只是用于临时调试,不需要安装阿里云CLI,您可使用阿里云提供的云命令行Cloud Shell来调用API接口获取云产品主机相关信息。

  1. 安装阿里云CLI。

  2. 配置阿里云CLI。

    配置调用阿里云资源所需的身份凭证信息、服务请求地域等。具体配置,请参见身份凭证类型

操作步骤

获取阿里云的地域信息

支持的所有地域
某个产品支持的地域
  • 请求命令

    您可以在阿里云CLI上运行以下命令,调用GetParametersByPath接口并使用公共参数路径,快速获取阿里云支持的所有地域信息。

    aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/regions

    其中,Path指定要获取的参数路径,在该场景下,路径指定为aliyun/services/global-infrastructure/regions公共参数路径,表示请求获取阿里云支持的所有地域信息。

  • 返回示例

    示例返回值包括支持的地域ID和名称,创建时间、更新时间等信息。仅展示部分地域,例如支持cn-hangzhoucn-shanghai地域。

    示例:cn-hangzhoucn-shanghai地域信息

    {
     "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"
    }
  • 请求命令

    您可以在阿里云CLI上运行以下命令,调用GetParametersByPath接口并使用公共参数路径,快速获取阿里云某个产品支持的地域信息。

    aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/products/oos/regions

    其中,Path指定要获取的参数路径,在此场景下,路径指定为aliyun/services/global-infrastructure/products/{product_code}/regions{product_code}为特定产品的代码(例如oos)。

  • 返回示例

    示例返回值包括地域ID和名称、创建时间、更新时间等信息。仅展示部分地域,例如获取到OOS产品支持cn-hangzhoucn-shanghai地域。

    示例: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"
    }

获取阿里云所有可用区

  • 请求命令

    您可以在阿里云CLI上运行以下命令,调用GetParametersByPath接口并使用公共参数路径,快速获取阿里云支持的所有可用区。

    aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/availability-zones

    其中,Path为指定要获取的参数路径。在此场景下,路径指定为aliyun/services/global-infrastructure/availability-zones,表示请求获取支持的所有可用区信息。

  • 返回示例

    示例返回值包括可用区ID和名称、创建时间、更新时间等信息。仅展示部分可用区,例如支持cn-shanghai-g-alipaycn-shanghai-x6可用区。

    示例:cn-shanghai-g-alipaycn-shanghai-x6可用区信息

    {
     "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"
    }

获取阿里云上线的云产品

  • 请求命令

    您可以在阿里云CLI上运行以下命令,调用GetParametersByPath接口并使用公共参数路径,快速获取阿里云的上线云产品信息。

    aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/products

    其中,Path为指定要获取的参数路径。在此场景下,路径指定为aliyun/services/global-infrastructure/products,表示请求获取所有上线的云产品信息。

  • 返回示例

    示例返回值包括云产品ID和名称、创建时间、更新时间等信息。仅展示部分云产品,例如上线产品为OOSECS

    示例:上线的OOSECS云产品信息

    {
     "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"
    }

获取阿里云某个产品的Endpoint

  • 请求命令

    您可以在阿里云CLI上运行以下命令,调用GetParametersByPath接口并使用公共参数路径,快速获取阿里云某个产品的Endpoint。

    aliyun oos GetParametersByPath --Path aliyun/services/global-infrastructure/products/oos/endpoints

    Path为指定要获取的参数路径。在此场景下,路径为aliyun/services/global-infrastructure/products/{product_code}/endpoints,其中,{product_code}是特定产品的代码(例如oos),表示请求OOS产品在特定地域的Endpoint信息。

  • 返回示例

    示例返回值包括EndpointID和名称、创建时间、更新时间等信息。仅展示OOS部分地域下的Endpoint,例如获取OOS产品在cn-hangzhoucn-shanghai地域下的Endpoint。

    示例:OOS在部分地域下的Endpoint信息

    {
     "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"
    }
  • 本页导读 (1)
  • 准备工作
  • 操作步骤
  • 获取阿里云的地域信息
  • 获取阿里云所有可用区
  • 获取阿里云上线的云产品
  • 获取阿里云某个产品的Endpoint
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等