All Products
Search
Document Center

Container Service for Kubernetes:DescribeClusterAddonMetadata

Last Updated:Nov 07, 2024
This API is deprecated. You are advised to use CS(2015-12-15) - DescribeAddon.

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeClusterAddonMetadataget
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringYes

The cluster ID.

c71d616e629ff40d5b42d7bb87770****
component_idstringYes

The component ID.

coredns
versionstringNo

The component version.

1.8.4.1

Response parameters

ParameterTypeDescriptionExample
object

The metadata of the component version.

namestring

The component name.

coredns
versionstring

The component version.

1.8.4.1
config_schemastring

The component schema parameters.

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

Examples

Sample success responses

JSONformat

{
  "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 Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-23The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-01-12The API operation is deprecatedView Change Details