Queries the details of an installed addon.
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:
- For mandatory resource types, indicate with a prefix of * .
- 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 |
|---|---|---|---|---|
| ehpc:GetAddon | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | Yes | The cluster ID. | ehpc-hz-FYUr32**** |
| AddonId | string | Yes | The addon ID. | Login-1.0-W4g**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "BBC2F93D-003A-49C4-850C-B826EECF****",
"Addon": {
"Name": "Login",
"Version": 1,
"AddonId": "Login-1.0-W2g****",
"Label": "",
"Description": "",
"Icon": "/assets/icons/your_icon.svg\n",
"InstallTime": "2024-08-22 18:11:17\n",
"Status": "Running",
"ServicesSpec": [
{
"ServiceName": "Web Portal",
"ServiceAccessType": "URL",
"ServiceAccessUrl": "https://47.96.xx.xx:12008",
"InputParams": [
{
"Name": "MYSQL_HOME\n",
"Label": "",
"Value": "usr/local/mysql\n",
"Type": "String\n",
"HelpText": ""
}
],
"NetworkACL": [
{
"IpProtocol": "TCP",
"Port": 3306,
"SourceCidrIp": "172.16.0.0/12\n"
}
]
}
],
"ResourcesSpec": {
"EipResource": {
"AutoCreate": true,
"EipInstanceId": "eip-bp1vi9124tbx1g3kr****",
"EipAddress": "39.108.xx.xx",
"InstanceChargeType": "PostPaid",
"InternetChargeType": "PayByTraffic",
"Bandwidth": 100
},
"EcsResources": [
{
"InstanceType": "ecs.c7.4xlarge",
"InstanceId": "i-bp1bzqq4rj1eemun****",
"PrivateIpAddress": "172.16.**.**",
"ImageId": "aliyun_3_x64_20G_alibase_20221102.vhd",
"OsName": "",
"OsNameEN": "CentOS 7.6 64 bit",
"InstanceChargeType": "PostPaid",
"PeriodUnit": "Month",
"Period": 1,
"AutoRenew": false,
"AutoRenewPeriod": 1,
"SpotStrategy": "NoSpot",
"SpotPriceLimit": 0.97,
"Duration": 1,
"EnableHT": true,
"SystemDisk": {
"Category": "cloud_essd",
"Size": 40,
"Level": "PL0"
},
"DataDisks": [
{
"Category": "cloud_essd",
"Size": 40,
"Level": "PL0",
"DeleteWithInstance": false
}
]
}
]
}
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | The specified parameter %s is invalid. |
| 400 | NotEnabled | You have not enabled this service | You have not enabled this service |
| 404 | ClusterNotFound | The specified cluster does not exist. | The specified instance does not exist. |
| 404 | ManagerNotFound | The manager nodes do not exist or their status is abnormal. | The manager nodes do not exist or their status is abnormal. |
| 406 | DbError | A database service error occurred. | Database request failed. |
| 406 | EcsError | An error occurred while calling the ECS API operation. | ECS API call error. %s |
| 406 | RedisError | A Redis service error occurred. | Redis request failed. |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | Alibaba Cloud product error. %s |
| 406 | AgentError | The agent service request failed: %s | Operation unsuccessful: %s |
| 407 | NotAuthorized | You are not authorized by RAM for this request. | The request is not authorized by RAM. |
| 500 | UnknownError | An unknown error occurred. | An unknown error occurred. |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | The request has failed due to a temporary failure of the server. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history