ModifyDedicatedHostAttribute - 修改专有宿主机属性--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

ModifyDedicatedHostAttribute - 修改专有宿主机属性

最近更新时间：2024.08.06 20:00:45首次发布时间：2024.04.22 11:34:50

调用 ModifyDedicatedHostAttribute 接口修改专有宿主机属性，包括名称、描述、CPU超分比、是否自动部署以及自动迁移等。

请求说明

调用该接口时，如不传入可选参数，则保持原有配置。
修改CPU超分比时，专有宿主机上的实例必须为已停止（Stopped）状态，您可以调用StopInstances接口停止实例。修改CPU超分比不会影响宿主机的运行状态。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ModifyDedicatedHostAttribute	要执行的操作，取值：ModifyDedicatedHostAttribute。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
AutoPlacement	String	否	Off	专有宿主机是否加入自动部署资源池，取值： On：加入自动部署资源池。创建实例时可以不指定DDH，由系统从自动部署池中选择合适的DDH部署实例。 Off（默认）：不加入自动部署资源池。您需自行在DDH上部署实例，即创建实例时指定DDH。创建实例操作请参见RunInstances。
ClientToken	String	否	23fa21A8823nfasd7f****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。
CpuOvercommitRatio	Float	否	4	CPU超分比，用于提升DDH的可用vCPU数。一台DDH的可用vCPU数 = 物理CPU核数 * 2 * CPU超分比。取值范围：1～4。默认值：支持配置的最大超分倍数。
DedicatedHostClusterId	String	否	dc-ycle6b76kgv2wrsm****	专有宿主机集群ID。您可以调用DescribeDedicatedHostClusters查询专有宿主机集群。
DedicatedHostId	String	是	dh-ycje2rquioh9l3bn****	专有宿主机ID。您可以调用DescribeDedicatedHosts查询专有宿主机ID。
DedicatedHostName	String	否	dedicated-host-test	专有宿主机的名称。不能以数字、下划线“_”、中划线“-”开头。只能包含中文、字母、数字、下划线“_”和中划线“-”。长度限制为1～128个字符。暂不支持特殊字符。
DedicatedHostRecovery	String	否	Off	专有宿主机处于临时不可用（TempUnavailable）状态时，是否开启宕机自动迁移，取值： On：开启宕机自动迁移。开启后，宿主机宕机时会自动迁移至健康的DDH。 Off（默认）：不开启宕机自动迁移。可以调用RedeployDedicatedHost手动更换物理机。
Description	String	否	用于测试的专有宿主机	专有宿主机的描述，默认值为空字符串。必须以字母或中文开头。只能包含中文、字母、数字、点“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。” 长度限制在255个字符以内。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET /?Action=ModifyDedicatedHostAttribute&Version=2020-04-01&DedicatedHostId=dh-ycje2rquioh9l3bn****&DedicatedHostName=dedicated-host HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202307171606530C0899E572405719****",
        "Action": "ModifyDedicatedHostAttribute",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	幂等参数不一致。
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	InvalidAutoPlacement.Malformed	The specified AutoPlacement is malformed.	指定的AutoPlacement不合法。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的ClientToken不合法。
400	InvalidCpuOvercommitRatio.Malformed	The specified CpuOvercommitRatio is malformed.	指定的超分比不合法。
400	InvalidDedicatedHostName.Malformed	The specified DedicatedHostName is malformed.	指定的DedicatedHostName不合法。
400	InvalidDedicatedHostRecovery.Malformed	The specified DedicatedHostRecovery is malformed.	指定的DedicatedHostRecovery不合法。
400	InvalidDedicatedHostStatus.Unsupported	The status of the specified dedicated host does not support this request.	当前专有宿主机的状态不支持此操作。
400	InvalidDescription.Malformed	The specified Description is malformed.	指定的描述不合法。
400	MissingParameter.DedicatedHostId	The required parameter DedicatedHostId is not supplied.	参数DedicatedHostId不能为空。
404	InvalidDedicatedHost.NotFound	The specified dedicated host does not exist.	指定的专有宿主机不存在。
404	InvalidDedicatedHostCluster.NotFound	The specified dedicated host cluster does not exist.	指定的专有宿主机集群不存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	先前的幂等请求仍在处理中，请稍后重试。
412	InvalidDedicatedHostCluster.ZoneIdMismatch	The zone of the specified dedicated host cluster does not match the dedicated host.	指定的专有宿主机集群与专有宿主机的可用区不匹配。
412	OperationDenied.InstanceStatus	Some instances on the dedicated host are not in the stopped status.	指定的专有宿主机不支持修改超分比，因为专有宿主机上存在不为停止状态的实例。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。