安装自定义服务组件。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ehpc:InstallAddon | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AddonName | string | 是 | 自定义服务组件名称。 | Login |
| AddonVersion | string | 是 | 自定义服务组件版本。 | 1.0 |
| ClusterId | string | 是 | 集群 ID。 | ehpc-hz-FYUr32**** |
| ServicesSpec | string | 是 | 组件服务配置详情。 | `[{"ServiceName": "SSH", "ServiceAccessType": null, "ServiceAccessUrl": null, "NetworkACL": [{"IpProtocol": "TCP", "Port": 22, "SourceCidrIp": "0.0.0.0/0"}]}, {"ServiceName": "VNC", "ServiceAccessType": null, "ServiceAccessUrl": null, "NetworkACL": [{"IpProtocol": "TCP", "Port": 12016, "SourceCidrIp": "0.0.0.0/0"}]}]` |
| ResourcesSpec | string | 是 | 组件资源配置详情。 | `{"EipResource": {"AutoCreate": true}, "EcsResources": [{"InstanceType": "ecs.c7.xlarge", "ImageId": "centos_7_6_xxx.vhd", "SystemDisk": {"Category": "cloud_essd", "Size": 40, "Level": "PL0"}]}` |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "B745C159-3155-4B94-95D0-4B73D4D2****",
"ClusterId": "ehpc-hz-FYUr32****",
"AddonId": "Login-1.0-W4g****"
}错误码
| 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调用出错 |
| 406 | RedisError | A Redis service error occurred. | Redis请求失败 |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误 |
| 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. | 未知错误 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败，服务暂时不可用 |
访问错误中心查看更多错误码。