查询自定义服务组件模板详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ehpc:DescribeAddonTemplate | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
| PageNumber | long | 否 | 分页序号，默认值为 1。 | 1 |
| PageSize | long | 否 | 分页查询时设置的每页大小，默认值 20。 | 20 |
| AddonName | string | 是 | 自定义服务组件名称。 | Login |
| AddonVersion | string | 是 | 自定义服务组件版本。 | 1.0 |
| ZoneId | string | 否 | 可用区 ID。 | cn-hangzhou-b |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
"PageSize": 20,
"PageNumber": 1,
"Addon": {
"Name": "Login",
"Version": 1,
"Label": "登录节点",
"Description": "登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。",
"Icon": "/assets/icons/your_icon.svg",
"LastUpdate": "2024-08-22 18:11:17",
"ServicesSpec": [
{
"ServiceName": "Web Portal",
"ServiceAccessType": "URL",
"ServiceAccessUrl": "https://47.96.xx.xx:12008",
"InputParams": [
{
"Name": "MYSQL_HOME",
"Label": "Mysql安装路径",
"Value": "usr/local/mysql",
"Type": "String",
"HelpText": "Mysql安装根目录"
}
],
"NetworkACL": [
{
"IpProtocol": "TCP",
"Port": 3306,
"SourceCidrIp": "172.16.0.0/12"
}
]
}
],
"ResourcesSpec": {
"EipResource": {
"AutoCreate": true,
"EipInstanceId": "eip-bp1jwtsuoiif2qf90****",
"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 | 您的账户还未开通此服务 |
| 404 | ClusterNotFound | The specified cluster does not exist. | 指定的集群不存在，请您检查该参数是否正确。 |
| 404 | ManagerNotFound | The manager nodes do not exist or their status is abnormal. | 管理节点不存在或状态异常。 |
| 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授权 |
| 500 | UnknownError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史