DescribeClusterAddonMetadata - 查询集群组件元数据

目前该API接口已标记为弃用,推荐使用替代API:CS(2015-12-15) - DescribeAddon

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeClusterAddonMetadataget
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

GET /clusters/{cluster_id}/components/{component_id}/metadata HTTP/1.1

请求参数

名称类型必填描述示例值
cluster_idstring

集群 ID

c71d616e629ff40d5b42d7bb87770****
component_idstring

组件 ID

coredns
versionstring

组件版本

1.8.4.1

返回参数

名称类型描述示例值
object

组件版本元数据

namestring

组件名称

coredns
versionstring

组件版本

1.8.4.1
config_schemastring

组件参数 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}

示例

正常返回示例

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-23API 内部配置变更,不影响调用查看变更详情
2024-01-12OpenAPI 变更为 deprecated,即将下线查看变更详情