Lists the installed add-ons.
Request SyntaxGET /clusters/name
/addons?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
The name of your cluster.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]*
Required: Yes
The maximum number of results, returned in paginated output. You receive maxResults
in a single page, along with a nextToken
response element. You can see the remaining results of the initial request by sending another request with the returned nextToken
value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a nextToken
value, if applicable, are returned.
Valid Range: Minimum value of 1. Maximum value of 100.
The nextToken
value returned from a previous paginated request, where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
The request does not have a request body.
Response SyntaxHTTP/1.1 200
Content-type: application/json
{
"addons": [ "string" ],
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
A list of installed add-ons.
Type: Array of strings
The nextToken
value to include in a future ListAddons
request. When the results of a ListAddons
request exceed maxResults
, you can use this value to retrieve the next page of results. This value is null
when there are no more results to return.
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
Type: String
For information about the errors that are common to all actions, see Common Errors.
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
HTTP Status Code: 400
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
HTTP Status Code: 400
The specified resource could not be found. You can view your available clusters with ListClusters
. You can view your available managed node groups with ListNodegroups
. Amazon EKS clusters and node groups are AWS Region specific.
HTTP Status Code: 404
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
In the following example or examples, the Authorization header contents (AUTHPARAMS
) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon EKS General Reference.
You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.
ExampleThe following example lists the add-ons installed to a cluster.
Sample RequestGET /clusters/1-18/addons HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34
X-Amz-Date: 20201125T144629Z
Authorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OK
Date: Wed, 25 Nov 2020 14:46:30 GMT
Content-Type: application/json
Content-Length: 39
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: WkYq8HCuvHcFU3Q=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive
{
"addons": ["vpc-cni"],
"nextToken": null
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4