开启/关闭集群节点授权-UpdateClusterSsh
功能介绍
开启或关闭MRS集群的节点授权,与查询集群节点授权状态接口配合使用,可查询当前授权状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/cluster/{cluster_id}/ssh
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cluster_id | 是 | String | 参数解释: 集群ID。获取方法,请参见获取集群ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字以及“_”和“-”组成,且长度为[1-64]个字符。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enable | 是 | Boolean | 参数解释: 集群节点授权开关配置。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
| expire_time | 否 | Number | 参数解释: 集群节点授权截止时间,单位为秒,如果不设置该值默认为1天授权时间。 约束限制: 仅开启集群节点授权时需要设置。 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
开启/关闭集群节点授权操作成功。
无
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 开启/关闭集群节点授权操作成功。 |
错误码
请参见错误码。