UpdateRspDomainServerProhibitStatusForGateway - Alibaba Cloud DNS

Updates the status of a specific domain name.

Operation description

Description

This operation is for gateway users to update the server-side status of a domain name.

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	Yes	An idempotence parameter.	asdf
DomainName	string	Yes	The domain name whose serverHold status you want to modify.	example.com
AddStatusList	array<object>	No	A collection of domain name statuses to add.
	object	No	A collection of domain name statuses to add.
Status	string	No	The domain name status.	serverDeleteProhibited
StatusMsg	string	No	The description of the status.	Authentication not passed. Add serverUpdateProhibited.
DeleteStatusList	array<object>	No	A collection of domain name statuses to delete.
	object	No	A collection of domain name statuses to delete.
Status	string	No	The domain name status.	serverDeleteProhibited
StatusMsg	string	No	The description of the status.	Authentication passed. Remove serverUpdateProhibited.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique ID of the request.	0629502C-6224-5DC9-A8ED-2ED73A2E3931
Success	boolean	Indicates whether the request was successful. `true`: The request was successful. `false`: The request failed.	true
RecoverableError	boolean	Indicates whether you can retry the request if it fails. `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 not passed. Add serverUpdateProhibited.
AccessDeniedDetail	object	The details about the access denial. This field is returned only when the Resource Access Management (RAM) verification fails.
AuthAction	string	The unauthorized operation that was attempted.	CreateUser
AuthPrincipalDisplayName	string	The display name of the authorized entity.	2015555733387XXXX
AuthPrincipalOwnerId	string	The ID of the owner of the authorized entity.	10469733312XXX
AuthPrincipalType	string	The identity type.	SubUser
EncodedDiagnosticMessage	string	The complete diagnostic information after encryption.	AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==
NoPermissionType	string	The reason why the authorization failed. Valid values: ExplicitDeny: The access is explicitly denied. ImplicitDeny: The access is implicitly denied.	ImplicitDeny
PolicyType	string	The policy type.	DlpSend

Examples

Success response

JSON format

{
  "RequestId": "0629502C-6224-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.