You can call the DescribeClusterAddonMetadata operation to query the metadata of a specified component version. The metadata includes the component version and available parameters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request syntax

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

Request parameters

Table 1. Request path parameters
Parameter Type Required Example Description
cluster_id String Yes c71d616e629ff40d5b42d7bb87770****

The ID of the cluster that you want to query.

component_id String Yes coredns

The ID of the component that you want to query.

version String No 1.8.4.1

The version of the component that you want to query.

Response syntax

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

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

Response parameters

Table 2. Response body parameters
Parameter Type Example Description
name String coredns

The name of the component.

version String 1.8.4.1

The version of the component.

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}

The schema of component parameters.

Examples

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

Sample success responses

XML format

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 format

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

Error codes

For a list of error codes, visit the API Error Center.