使用UpdateRspDomainServerHoldStatusOte为网关用户更新域名serverHold状态-云解析DNS-阿里云

用于更新特定域名的serverHold状态信息。

接口说明

请求说明

本接口专为网关用户设计，允许他们更新指定域名的 serverHold 属性。
必须提供OperatorType，OperatorId，DomainName，ServerHoldStatus，StatusMsg参数以标识要修改的具体网关下的特点域名的 serverHold 状态以及修改原因。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	幂等参数	443F1A21-XXXX-55C4-93E1-FF020DF93D7B
OperatorType	string	是	操作类型，固定 registryGateway 枚举值： registryGateway : registryGateway	registryGateway
OperatorId	string	是	操作 ID，网关 ID	gatewayId001
DomainName	string	是	需要修改 serverHold 状态的域名	example.com
ServerHoldStatus	string	是	开启/enable，关闭/disable 域名 serverHold 状态	enable
StatusMsg	string	是	实名认证未通过，增加 serverHold 状态	实名认证未通过，增加serverHold状态

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求唯一标识	0629502C-XXXX-XXXX-XXXX-2ED73A2E3931
Success	boolean	请求是否成功，`true`：成功，`false`：失败	true
RecoverableError	boolean	请求失败能否重试，`true`：可重试，`false`：不可重试	true
Data	object	返回数据列表。
DomainName	string	域名名称。	example.com
ServerHoldStatus	string	编辑后的 serverHold 状态	enable
AccessDeniedDetail	object	访问被拒绝详细信息，只有 RAM 校验失败才会返回此字段。
AuthAction	string	尝试执行的未授权操作。	CreateUser
AuthPrincipalDisplayName	string	授权主体显示名称。	2015555733387XXXX
AuthPrincipalOwnerId	string	授权主体所有者 ID。	1046973331XXXX
AuthPrincipalType	string	身份类型	SubUser
EncodedDiagnosticMessage	string	加密后的完整诊断信息。	AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==
NoPermissionType	string	导致鉴权失败的原因。具体取值为： ExplicitDeny：显示拒绝 ImplicitDeny：隐式拒绝	ImplicitDeny
PolicyType	string	策略类型。	DlpSend

示例

正常返回示例

JSON格式

{
  "RequestId": "0629502C-XXXX-XXXX-XXXX-2ED73A2E3931",
  "Success": true,
  "RecoverableError": true,
  "Data": {
    "DomainName": "example.com",
    "ServerHoldStatus": "enable"
  },
  "AccessDeniedDetail": {
    "AuthAction": "CreateUser",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "1046973331XXXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Alirs.Operator.NotAuthorized	The operator does not belong to the cloud account.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。