使用GetAddon查询自定义服务组件详情-弹性高性能计算-阿里云-弹性高性能计算(E-HPC)-阿里云帮助中心

查询已安装的自定义服务组件详情。

调试

您可以在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	自定义服务组件安装日期，格式为 YYYY-MM-DD HH:mm:ss。	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授权

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。