调用ModifyDedicatedHostAttribute修改一台专有宿主机的部分信息,包括专有宿主机的名称、描述和服务不可用属性等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:ModifyDedicatedHostAttribute | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 专有宿主机所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
DedicatedHostId | string | 是 | 专有宿主机 ID。 | dh-bp165p6xk2tlw61e**** |
DedicatedHostName | string | 否 | 专有宿主机名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以 http://和 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。 | testDedicatedHostName |
Description | string | 否 | 专有宿主机的描述。长度为 2~256 个英文或中文字符,不能以 | testDescription |
ActionOnMaintenance | string | 否 | 当专有宿主机发生故障或者在线修复时,为其所宿实例设置迁移方案。取值范围:
当专有宿主机上挂载的是云盘时,默认值:Migrate。 当专有宿主机上挂载的是本地盘时,默认值:Stop。 | Migrate |
NetworkAttributes.SlbUdpTimeout | integer | 否 | 负载均衡连接的 UDP 会话超时时间,单位:秒。取值范围:15~310。 | 60 |
NetworkAttributes.UdpTimeout | integer | 否 | 为专有宿主机上运行的云服务设置用户访问的 UDP 会话超时时间,单位:秒。取值范围:15~310。 | 60 |
AutoPlacement | string | 否 | 设置专有宿主机是否加入自动部署资源池。当您在专有宿主机上创建实例,却不指定 DedicatedHostId 时,阿里云自动从资源池中选取专有宿主机放置实例。取值范围:
自动部署功能详情,请参见功能特性。 | on |
DedicatedHostClusterId | string | 否 | 专有宿主机集群 ID。 | dc-bp165p6xk2tlw61e**** |
CpuOverCommitRatio | float | 否 | CPU 超卖比。仅自定义规格 g6s、c6s、r6s 支持设置 CPU 超卖比。取值范围:1~5。 CPU 超卖比影响 DDH 的可用 vCPU 数,一台 DDH 的可用 vCPU 数=物理 CPU 核数*2*CPU 超卖比。例如,g6s 的物理 CPU 核数为 52,如果设置 CPU 超卖比为 4,则修改完成后 vCPU 总数显示为 416。针对 CPU 绝对稳定性要求不严苛或者 CPU 负载不高的场景,例如开发测试环境,提升超卖比可以提升可用 vCPU 数,用于部署更多同等规格的 ECS 实例,降低单位部署成本。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "2A4EA075-CB5B-41B7-B0EB-70D339F6****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidDedicatedHostName.Malformed | The specified parameter DedicatedHostName is not valid. | 指定的参数 DedicatedHostName 无效。 |
400 | InvalidDescription.Malformed | The specified parameter Description is not valid. | 指定的资源描述格式不合法。长度为 2-256 个字符,不能以 http:// 和 https:// 开头。 |
400 | InvalidParameter.SlbUdpTimeout | The specified value is invalid. | 指定的参数 SlbUdpTimeout 无效。 |
400 | InvalidParameter.UdpTimeout | The specified value is invalid. | 指定的参数 UdpTimeout 无效。 |
400 | InvalidDedicatedHostType.CpuOverCommitRatioNotSupported | %s | - |
400 | InvalidCpuOverCommitRatio.ValueNotSupported | %s | - |
403 | InvalidUser.Unauthorized | The user is not authorized | 您当前使用的账号无权限。 |
404 | InvalidDedicatedHostId.NotFound | The specified DedicatedHostId does not exist. | 指定的专有宿主机不存在。 |
404 | InvalidDedicatedHostClusterId.NotFound | The specified DedicatedHostClusterId does not exist. | - |
404 | InvalidDedicatedHostClusterId.ExceedMaxSize | The specified Dedicated Host Cluster exceeded max capacity. | - |
404 | InvalidDedicatedHostClusterId.NotMatch | The specified DedicatedHostCluster does not match request. | - |
404 | InvalidParameter.ActionOnMaintenance | The specified ActionOnMaintenance does not exist. | 指定的迁移方案不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-09-04 | OpenAPI 错误码发生变更 | 查看变更详情 |