GetAddon API用於查詢已安裝的自訂服務元件詳情-彈性高效能運算-阿里雲

查詢已安裝的自訂服務元件詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ehpc:GetAddon

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ClusterId	string	是	叢集 ID。	ehpc-hz-FYUr32****
AddonId	string	是	自訂服務元件 ID。	Login-1.0-W4g****

返回參數

名稱	類型	描述	樣本值
	object	返回參數。
RequestId	string	請求 ID。	BBC2F93D-003A-49C4-850C-B826EECF****
Addon	object	自訂服務元件。
Name	string	自訂服務元件名稱。	Login
Version	string	自訂服務元件版本。	1.0
AddonId	string	自訂服務元件 ID。	Login-1.0-W2g****
Label	string	自訂服務元件標籤。	登入節點
Description	string	自訂服務元件描述。	登入節點，主要用於E-HPC叢集環境的串連登入及使用者任務的提交。
Icon	string	自訂服務元件表徵圖。	/assets/icons/your_icon.svg
InstallTime	string	自訂服務元件安裝日期。	2024-08-22 18:11:17
Status	string	自訂服務元件狀態。	Running
ServicesSpec	array<object>	元件服務配置資訊。
	array<object>	服務配置詳情。
ServiceName	string	服務名稱。	Web Portal
ServiceAccessType	string	服務訪問類型。	URL
ServiceAccessUrl	string	服務訪問 Url。	https://47.96.xx.xx:12008
InputParams	array<object>	服務參數配置。
	object	參數詳情。
Name	string	參數名稱。	MYSQL_HOME
Label	string	參數標籤。	Mysql安裝路徑
Value	string	參數值。	usr/local/mysql
Type	string	參數類型。	String
HelpText	string	參數協助。	Mysql安裝根目錄
NetworkACL	array<object>	服務安全性群組配置。
	object	安全性群組規則。
IpProtocol	string	協議類型，可取值： TCP：轉寄 TCP 協議的報文。 UDP：轉寄 UDP 協議的報文。 Any：轉寄所有協議的報文。	TCP
Port	number	連接埠號碼。	3306
SourceCidrIp	string	源位址區段。	172.16.0.0/12
ResourcesSpec	object	組件資源配置資訊。
EipResource	object	彈性公網 IP 配置。
AutoCreate	boolean	是否自動建立。	True
EipInstanceId	string	彈性公網 IP ID。	eip-bp1vi9124tbx1g3kr****
EipAddress	string	彈性公網 IP 位址。	39.108.xx.xx
InstanceChargeType	string	EIP 的計費方式。 PostPaid：隨用隨付 PrePaid：訂用帳戶預設值：PostPaid	PostPaid
InternetChargeType	string	EIP 的計量方式。取值範圍： PayByBandwidth：按固定頻寬收費 PayByTraffic：按流量計費 N 的取值範圍：1~10	PayByTraffic
Bandwidth	string	EIP 的頻寬峰值。單位：Mbps。	100
EcsResources	array	自訂服務元件 ECS 資源配置。
	AddonNodeTemplate	ECS 節點配置資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "BBC2F93D-003A-49C4-850C-B826EECF****",
  "Addon": {
    "Name": "Login",
    "Version": "1.0",
    "AddonId": "Login-1.0-W2g****",
    "Label": "登入節點",
    "Description": "登入節點，主要用於E-HPC叢集環境的串連登入及使用者任務的提交。",
    "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": "Mysql安裝路徑\n",
            "Value": "usr/local/mysql\n",
            "Type": "String\n",
            "HelpText": "Mysql安裝根目錄"
          }
        ],
        "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": "CentOS  7.6 64 位元",
          "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
            }
          ]
        }
      ]
    }
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParams	The specified parameter %s is invalid.	指定的參數 %s 無效。
400	NotEnabled	You have not enabled this service	您的賬戶還未開通此服務
500	UnknownError	An unknown error occurred.	未知錯誤
404	ClusterNotFound	The specified cluster does not exist.	指定的叢集不存在，請您檢查該參數是否正確。
404	ManagerNotFound	The manager nodes do not exist or their status is abnormal.	管理節點不存在或狀態異常。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	請求失敗，服務暫時不可用
406	DbError	A database service error occurred.	資料庫請求失敗
406	EcsError	An error occurred while calling the ECS API operation.	ECS API調用出錯. %s
406	RedisError	A Redis service error occurred.	Redis請求失敗
406	AliyunError	An Alibaba Cloud product error occurred.	阿里雲產品錯誤。%s
406	AgentError	The agent service request failed: %s	操作未成功：%s
407	NotAuthorized	You are not authorized by RAM for this request.	此請求未獲得RAM授權

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。