UpdateRspDomainStatusOte - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Updates the status of a specified domain name.

Operation description

Description

This API operation allows gateway users to update the status of a specified domain name.
You must specify the OperatorType, OperatorId, and DomainName parameters to identify the domain name and gateway for the update.
You can use the optional AddStatusList and DeleteStatusList parameters to specify the domain name statuses to add or delete. These parameters contain Status and StatusMsg.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	An idempotence parameter.	443F1A21-XXXX-55C4-93E1-FF020DF93D7B
OperatorType	string	Yes	The type of operation. This parameter is fixed to `registryGateway`. Valid values: registryGateway : registryGateway	registryGateway
OperatorId	string	Yes	The operation ID, which is the gateway ID.	gatewayId001
DomainName	string	Yes	The domain name whose status you want to update.	example.com
AddStatusList	array<object>	No	The collection of domain name statuses to add.	[{"Status":"renewProhibited","StatusMsg":"test"}]
	object	No
Status	string	No	The domain name status. Valid values: serverDeleteProhibited: serverDeleteProhibited serverRenewProhibited: serverRenewProhibited serverTransferProhibited: serverTransferProhibited serverUpdateProhibited: serverUpdateProhibited	serverDeleteProhibited
StatusMsg	string	No	A description of the status.	Authentication failed. Add serverUpdateProhibited
DeleteStatusList	array<object>	No	The collection of domain name statuses to delete.	[{"Status":"renewProhibited","StatusMsg":"test"}]
	object	No
Status	string	No	The domain name status. Valid values: serverDeleteProhibited : serverDeleteProhibited serverRenewProhibited: serverRenewProhibited serverTransferProhibited: serverTransferProhibited serverUpdateProhibited: serverUpdateProhibited	serverDeleteProhibited
StatusMsg	string	No	A description of the status.	Authentication passed. Delete serverUpdateProhibited

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The unique ID of the request.	0629502C-XXXX-5DC9-A8ED-2ED73A2E3931
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
RecoverableError	boolean	Indicates whether you can retry the request if it fails. Valid values: `true`: You can retry the request. `false`: You cannot retry the request.	true
Data	object	The returned data.
DomainName	string	The domain name.	example.com
StatusList	array<object>	The status information of the task.
	object	The status information of the task.
DomainName	string	The domain name.	uptp.test.abchina.com.cn
Status	string	The current status of the domain name.	serverUpdateProhibited
StatusMsg	string	The message for the domain name status.	Authentication failed. Add serverUpdateProhibited
AccessDeniedDetail	object	The details about the access denial. This field is returned only if RAM authentication fails.
AuthAction	string	The unauthorized operation that was attempted.	CreateUser
AuthPrincipalDisplayName	string	The display name of the principal.	2015555733387XXXX
AuthPrincipalOwnerId	string	The ID of the principal's owner.	10469733312XXX
AuthPrincipalType	string	The type of principal.	SubUser
EncodedDiagnosticMessage	string	The complete diagnostic information, which is encrypted.	AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==
NoPermissionType	string	The reason for the authentication failure. Valid values: ExplicitDeny: Access is explicitly denied. ImplicitDeny: Access is implicitly denied.	ImplicitDeny
PolicyType	string	The type of policy.	DlpSend

Examples

Success response

JSON format

{
  "RequestId": "0629502C-XXXX-5DC9-A8ED-2ED73A2E3931",
  "Success": true,
  "RecoverableError": true,
  "Data": {
    "DomainName": "example.com",
    "StatusList": [
      {
        "DomainName": "uptp.test.abchina.com.cn",
        "Status": "serverUpdateProhibited",
        "StatusMsg": "实名认证未通过，增加serverUpdateProhibited状态"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "CreateUser",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "10469733312XXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Alirs.Operator.NotAuthorized	The operator does not belong to the cloud account.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.