GetAddon - 查询已安装组件详情

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:GetAddonget
*全部资源
*

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

ehpc-hz-FYUr32****
AddonIdstring

自定义服务组件 ID。

Login-1.0-W4g****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

BBC2F93D-003A-49C4-850C-B826EECF****
Addonobject

自定义服务组件。

Namestring

自定义服务组件名称。

Login
Versionstring

自定义服务组件版本。

1.0
AddonIdstring

自定义服务组件 ID。

Login-1.0-W2g****
Labelstring

自定义服务组件标签。

登录节点
Descriptionstring

自定义服务组件描述。

登录节点,主要用于E-HPC集群环境的连接登录及用户任务的提交。
Iconstring

自定义服务组件图标。

/assets/icons/your_icon.svg
InstallTimestring

自定义服务组件安装日期。

2024-08-22 18:11:17
Statusstring

自定义服务组件状态。

Running
ServicesSpecarray<object>

组件服务配置信息。

ServiceInfoobject

服务配置详情。

ServiceNamestring

服务名称。

Web Portal
ServiceAccessTypestring

服务访问类型。

URL
ServiceAccessUrlstring

服务访问 Url。

https://47.96.xx.xx:12008
InputParamsarray<object>

服务参数配置。

InputParamobject

参数详情。

Namestring

参数名称。

MYSQL_HOME
Labelstring

参数标签。

Mysql安装路径
Valuestring

参数值。

usr/local/mysql
Typestring

参数类型。

String
HelpTextstring

参数帮助。

Mysql安装根目录
NetworkACLarray<object>

服务安全组配置。

NetworkACLobject

安全组规则。

IpProtocolstring

协议类型,可取值:

TCP:转发 TCP 协议的报文。

UDP:转发 UDP 协议的报文。

Any:转发所有协议的报文。

TCP
Portfloat

端口号。

3306
SourceCidrIpstring

源地址段。

172.16.0.0/12
ResourcesSpecobject

组件资源配置信息。

EipResourceobject

弹性公网 IP 配置。

AutoCreateboolean

是否自动创建。

True
EipInstanceIdstring

弹性公网 IP ID。

eip-bp1vi9124tbx1g3kr****
EipAddressstring

弹性公网 IP 地址。

39.108.xx.xx
InstanceChargeTypestring

EIP 的计费方式。

  • PostPaid:按量付费
  • PrePaid:包年包月

默认值:PostPaid

PostPaid
InternetChargeTypestring

EIP 的计量方式。取值范围:

  • PayByBandwidth:按固定带宽收费
  • PayByTraffic:按流量计费

N 的取值范围:1~10

PayByTraffic
Bandwidthstring

EIP 的带宽峰值。单位:Mbps。

100
EcsResourcesarray

自定义服务组件 ECS 资源配置。

EcsResourceAddonNodeTemplate

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错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.指定的参数 %s 无效。
400NotEnabledYou have not enabled this service您的账户还未开通此服务
404ClusterNotFoundThe specified cluster does not exist.指定的集群不存在,请您检查该参数是否正确。
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.管理节点不存在或状态异常。
406DbErrorA database service error occurred.数据库请求失败
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
406RedisErrorA Redis service error occurred.Redis请求失败
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误
406AgentErrorThe agent service request failed: %s操作未成功:%s
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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