调用DescribeClusterAddonMetadata查询特定集群可使用的指定组件版本信息,包括组件版本、可配置参数等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求语法

GET /clusters/cluster_id/components/component_id/metadata HTTP/1.1
Content-Type:application/json

请求参数

表 1. 请求Path参数
参数名称 类型 是否必选 示例 说明
cluster_id String c71d616e629ff40d5b42d7bb87770****

集群ID

component_id String coredns

组件ID

version String 1.8.4.1

组件版本

响应体语法

HTTP/1.1 200 OK
Content-Type:application/json

{
  "name" : "String",
  "version" : "String",
  "config_schema" : "String"
}

响应参数

表 2. 响应Body参数
参数名称 类型 示例 说明
name String coredns

组件名称

version String 1.8.4.1

组件版本

config_schema String {\n \"$schema\": \"https://json-schema.org/draft-07/schema#\",\n \"properties\": {\n \"controller\": {\n \"description\": \"\",\n \"properties\": {\n \"resources\": {\n \"properties\": {\n \"armsPrometheusOperator\": {\n \"properties\": {\n \"resources\": {\n \"properties\": {\n \"limits\": {\n \"properties\": {\n \"memory\": {\n \"description\": \"memory limit of arms prometheus operator\",\n \"type\": \"string\",\n \"pattern\": \"^[1-9][0-9]*(\\\\.\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\",\n \"default\": \"500m\",\n \"x-ui-description\": \"<mds-key>\",\n \"x-ui-prompt-message\": \"<mds-key>\",\n \"x-ui-validation-message\": \"<mds-key>\",\n \"x-ui-additional-tips\": \"<mds-key>\"\n },\n \"cpu\": {\n \"description\": \"cpu limit of arms prometheus operator\",\n \"type\": \"string\",\n \"pattern\": \"^[1-9][0-9]*(m|\\\\.\\\\d+)?$\",\n \"default\": \"1.0\",\n \"x-ui-description\": \"<mds-key>\",\n \"x-ui-validation-message\": \"<mds-key>\"\n }\n },\n \"type\": \"object\",\n \"additionalProperties\": false\n },\n \"requests\": {\n \"properties\": {\n \"memory\": {\n \"description\": \"memory request of arms prometheus operator\",\n \"type\": \"string\",\n \"pattern\": \"^[1-9][0-9]*(\\\\.\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\",\n \"default\": \"500m\",\n \"x-ui-description\": \"<mds-key>\",\n \"x-ui-validation-message\": \"<mds-key>\"\n },\n \"cpu\": {\n \"description\": \"cpu request of arms prometheus operator\",\n \"type\": \"string\",\n \"pattern\": \"^[1-9][0-9]*(m|\\\\.\\\\d+)?$\",\n \"default\": \"1.0\",\n \"x-ui-description\": \"<mds-key>\",\n \"x-ui-validation-message\": \"<mds-key>\"\n }\n },\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"title\": \"Values\",\n \"type\": \"object\",\n \"additionalProperties\": false\n}

组件参数Schema

查询集群可用的CoreDNS组件最新版本元数据

GET /clusters/c71d616e629ff40d5b42d7bb87770****/components/coredns/metadata HTTP/1.1
Host:cs.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeClusterAddonMetadataResponse>
    <name>coredns</name>
    <version>1.8.4.1</version>
    <config_schema>{\n  \"$schema\": \"https://json-schema.org/draft-07/schema#\",\n  \"properties\": {\n    \"controller\": {\n      \"description\": \"\",\n      \"properties\": {\n        \"resources\": {\n          \"properties\": {\n            \"armsPrometheusOperator\": {\n              \"properties\": {\n                \"resources\": {\n                  \"properties\": {\n                    \"limits\": {\n                      \"properties\": {\n                        \"memory\": {\n                          \"description\": \"memory limit of arms prometheus operator\",\n                          \"type\": \"string\",\n                          \"pattern\": \"^[1-9][0-9]*(\\\\.\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\",\n                          \"default\": \"500m\",\n                          \"x-ui-description\": \"&lt;mds-key&gt;\",\n                          \"x-ui-prompt-message\": \"&lt;mds-key&gt;\",\n                          \"x-ui-validation-message\": \"&lt;mds-key&gt;\",\n                          \"x-ui-additional-tips\": \"&lt;mds-key&gt;\"\n                        },\n                        \"cpu\": {\n                          \"description\": \"cpu limit of arms prometheus operator\",\n                          \"type\": \"string\",\n                          \"pattern\": \"^[1-9][0-9]*(m|\\\\.\\\\d+)?$\",\n                          \"default\": \"1.0\",\n                          \"x-ui-description\": \"&lt;mds-key&gt;\",\n                          \"x-ui-validation-message\": \"&lt;mds-key&gt;\"\n                        }\n                      },\n                      \"type\": \"object\",\n                      \"additionalProperties\": false\n                    },\n                    \"requests\": {\n                      \"properties\": {\n                        \"memory\": {\n                          \"description\": \"memory request of arms prometheus operator\",\n                          \"type\": \"string\",\n                          \"pattern\": \"^[1-9][0-9]*(\\\\.\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\",\n                          \"default\": \"500m\",\n                          \"x-ui-description\": \"&lt;mds-key&gt;\",\n                          \"x-ui-validation-message\": \"&lt;mds-key&gt;\"\n                        },\n                        \"cpu\": {\n                          \"description\": \"cpu request of arms prometheus operator\",\n                          \"type\": \"string\",\n                          \"pattern\": \"^[1-9][0-9]*(m|\\\\.\\\\d+)?$\",\n                          \"default\": \"1.0\",\n                          \"x-ui-description\": \"&lt;mds-key&gt;\",\n                          \"x-ui-validation-message\": \"&lt;mds-key&gt;\"\n                        }\n                      },\n                      \"type\": \"object\",\n                      \"additionalProperties\": false\n                    }\n                  },\n                  \"type\": \"object\",\n                  \"additionalProperties\": false\n                }\n              },\n              \"type\": \"object\",\n              \"additionalProperties\": false\n            }\n          },\n          \"type\": \"object\",\n          \"additionalProperties\": false\n        }\n      },\n      \"type\": \"object\",\n      \"additionalProperties\": false\n    }\n  },\n  \"title\": \"Values\",\n  \"type\": \"object\",\n  \"additionalProperties\": false\n}</config_schema>
</DescribeClusterAddonMetadataResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "name" : "coredns",
  "version" : "1.8.4.1",
  "config_schema" : "{\\n  \\\"$schema\\\": \\\"https://json-schema.org/draft-07/schema#\\\",\\n  \\\"properties\\\": {\\n    \\\"controller\\\": {\\n      \\\"description\\\": \\\"\\\",\\n      \\\"properties\\\": {\\n        \\\"resources\\\": {\\n          \\\"properties\\\": {\\n            \\\"armsPrometheusOperator\\\": {\\n              \\\"properties\\\": {\\n                \\\"resources\\\": {\\n                  \\\"properties\\\": {\\n                    \\\"limits\\\": {\\n                      \\\"properties\\\": {\\n                        \\\"memory\\\": {\\n                          \\\"description\\\": \\\"memory limit of arms prometheus operator\\\",\\n                          \\\"type\\\": \\\"string\\\",\\n                          \\\"pattern\\\": \\\"^[1-9][0-9]*(\\\\\\\\.\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\\",\\n                          \\\"default\\\": \\\"500m\\\",\\n                          \\\"x-ui-description\\\": \\\"<mds-key>\\\",\\n                          \\\"x-ui-prompt-message\\\": \\\"<mds-key>\\\",\\n                          \\\"x-ui-validation-message\\\": \\\"<mds-key>\\\",\\n                          \\\"x-ui-additional-tips\\\": \\\"<mds-key>\\\"\\n                        },\\n                        \\\"cpu\\\": {\\n                          \\\"description\\\": \\\"cpu limit of arms prometheus operator\\\",\\n                          \\\"type\\\": \\\"string\\\",\\n                          \\\"pattern\\\": \\\"^[1-9][0-9]*(m|\\\\\\\\.\\\\\\\\d+)?$\\\",\\n                          \\\"default\\\": \\\"1.0\\\",\\n                          \\\"x-ui-description\\\": \\\"<mds-key>\\\",\\n                          \\\"x-ui-validation-message\\\": \\\"<mds-key>\\\"\\n                        }\\n                      },\\n                      \\\"type\\\": \\\"object\\\",\\n                      \\\"additionalProperties\\\": false\\n                    },\\n                    \\\"requests\\\": {\\n                      \\\"properties\\\": {\\n                        \\\"memory\\\": {\\n                          \\\"description\\\": \\\"memory request of arms prometheus operator\\\",\\n                          \\\"type\\\": \\\"string\\\",\\n                          \\\"pattern\\\": \\\"^[1-9][0-9]*(\\\\\\\\.\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\\",\\n                          \\\"default\\\": \\\"500m\\\",\\n                          \\\"x-ui-description\\\": \\\"<mds-key>\\\",\\n                          \\\"x-ui-validation-message\\\": \\\"<mds-key>\\\"\\n                        },\\n                        \\\"cpu\\\": {\\n                          \\\"description\\\": \\\"cpu request of arms prometheus operator\\\",\\n                          \\\"type\\\": \\\"string\\\",\\n                          \\\"pattern\\\": \\\"^[1-9][0-9]*(m|\\\\\\\\.\\\\\\\\d+)?$\\\",\\n                          \\\"default\\\": \\\"1.0\\\",\\n                          \\\"x-ui-description\\\": \\\"<mds-key>\\\",\\n                          \\\"x-ui-validation-message\\\": \\\"<mds-key>\\\"\\n                        }\\n                      },\\n                      \\\"type\\\": \\\"object\\\",\\n                      \\\"additionalProperties\\\": false\\n                    }\\n                  },\\n                  \\\"type\\\": \\\"object\\\",\\n                  \\\"additionalProperties\\\": false\\n                }\\n              },\\n              \\\"type\\\": \\\"object\\\",\\n              \\\"additionalProperties\\\": false\\n            }\\n          },\\n          \\\"type\\\": \\\"object\\\",\\n          \\\"additionalProperties\\\": false\\n        }\\n      },\\n      \\\"type\\\": \\\"object\\\",\\n      \\\"additionalProperties\\\": false\\n    }\\n  },\\n  \\\"title\\\": \\\"Values\\\",\\n  \\\"type\\\": \\\"object\\\",\\n  \\\"additionalProperties\\\": false\\n}"
}

错误码

访问错误中心查看更多错误码。

开发者资源

  • SDK

    阿里云为您提供多种语言的SDK,帮助您快速通过API集成阿里云的产品和服务,推荐您使用SDK调用API,已免除您手动签名验证。

  • OpenAPI Explorer

    快速检索,可视化调试API,在线命令行工具,同步动态生成可执行的SDK代码示例。

  • 阿里云CLI

    阿里云资产管理和配置工具,可通过命令方式同时管理多个阿里云产品和服务,简单快捷,是您上云好帮手。