You can call the DescribeClusterAddonMetadata operation to query the metadata of a component version. The metadata includes the component version and available parameters.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cs:DescribeClusterAddonMetadata | Read |
|
| none |
Request syntax
GET /clusters/{cluster_id}/components/{component_id}/metadata
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| cluster_id | string | Yes | The cluster ID. | c71d616e629ff40d5b42d7bb87770**** |
| component_id | string | Yes | The component ID. | coredns |
| version | string | No | The component version. | 1.8.4.1 |
Response parameters
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 time | Summary of changes | Operation | ||
|---|---|---|---|---|
| 2024-01-12 | The API operation is deprecated | see changesets | ||
|