Modifies an Active Directory (AD) workspace.


This operation modifies the domain name and DNS parameters of only AD workspaces in the Error (ERROR) or Registering (REGISTERING) state. DNS parameters include DomainName, SubDomainName, DnsAddress.N, and SubDomainDnsAddress.N.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyADConnectorOfficeSite

The operation that you want to perform. Set the value to ModifyADConnectorOfficeSite.

OfficeSiteId String Yes cn-hangzhou+dir-363353****

The ID of the workspace.

RegionId String Yes cn-hangzhou

The ID of the region.

DomainName String No

The domain name of the enterprise AD system. Each domain name can be registered only once.

DomainUserName String No Administrator

The username of the domain administrator. The username must be 1 to 64 characters in length.

Note Use sAMAccountName as the username of the domain administrator. Do not use userPrincipalName.
DomainPassword String No testPassword

The password of the domain administrator. The password must be 1 to 64 characters in length.

DnsAddress.N RepeatList No 127.0.*.*

IP address N of the DNS server of the enterprise AD system. You can specify only one IP address.

OfficeSiteName String No test

The name of the workspace. The name must be 2 to 255 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

SubDomainDnsAddress.N RepeatList No 127.0.*.*

The DNS address of enterprise AD subdomain N. You can specify only one DNS address. If you specify SubDomainName but not this parameter, the DNS address of the subdomain is considered to be the same as that of the parent domain.

SubDomainName String No

The domain name of the enterprise AD subdomain.

MfaEnabled Boolean No false

Specifies whether to enable multi-factor authentication (MFA).

Default value: false.

Response parameters

Parameter Type Example Description
RequestId String 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF

The ID of the request.


Sample requests
&<Common request parameters>

Sample success response

XML format


JSON format


Error codes

For a list of error codes, visit the API Error Center.