Retrieve ENS Addon Details with DescribeAddon API - ENS

Operation description

Each user is limited to 100 calls per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeAddon

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AddonName	string	Yes	The name of the component.	edge-csi-lite
AddonVersion	string	No	The version of the component. If you do not specify this parameter, all active versions are returned by default.	v1

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Addons	array<object>	The information about the component.
	array<object>	The information about the component.
Name	string	The name of the component.	edge-csi-lite
Version	string	The version of the component.	v1
CleanupCloudResources	string	Indicates whether to automatically clean up associated cloud resources.	true
ConfigSchema	array<object>	The schema of the custom parameters for the component.
	object	The schema of the custom parameters for the component.
AppVersion	string	The version of the application.	859e9d595b2974ed79c444658d1dea89
ConfigVersion	string	The version of the configuration.	4155709cd12a09bdb8cbaca71bf03233
Name	string	The name of the component.	edge-csi-lite
Params	any	The custom parameters of the component.	{"key1":"val1"}

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Addons": [
    {
      "Name": "edge-csi-lite",
      "Version": "v1",
      "CleanupCloudResources": "true",
      "ConfigSchema": [
        {
          "AppVersion": "859e9d595b2974ed79c444658d1dea89",
          "ConfigVersion": "4155709cd12a09bdb8cbaca71bf03233",
          "Name": "edge-csi-lite",
          "Params": "{\"key1\":\"val1\"}"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.