Modifies the basic properties of an enterprise Active Directory (AD) office network, such as the office network name and domain names of the enterprise AD subdomains.
Operation description
You can modify parameters of domain names and Domain Name System (DNS) for enterprise AD office networks that are in the ERROR or REGISTERED state. The parameters include DomainName, SubDomainName, DnsAddress.N, and SubDomainDnsAddress.N.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:ModifyADConnectorOfficeSite | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| OfficeSiteId | string | Yes | The office network ID. | cn-hangzhou+dir-363353**** |
| DomainName | string | No | The domain name of the enterprise AD system. You can register each domain name only once. | example.com |
| DomainUserName | string | No | The username of the domain administrator. The username can be up to 64 characters in length. Note
Specify the value of the sAMAccountName parameter instead of the value of the userPrincipalName parameter as the username.
| Administrator |
| DomainPassword | string | No | The password of the domain administrator. The username can be up to 64 characters in length. | testPassword |
| OfficeSiteName | string | No | The office network name. The name must be 2 to 255 characters in length. It can contain letters, digits, colons (:), underscores (_), and hyphens (-). It must start with a letter and cannot start with | test |
| SubDomainName | string | No | The name of the subdomain in the enterprise AD domain. | childexample.com |
| MfaEnabled | boolean | No | Specifies whether to enable multi-factor authentication (MFA). Valid values:
| false |
| DnsAddress | array | No | Details of the IP addresses of the Domain Name System (DNS) servers that correspond to the enterprise AD system. You can specify only one IP address. | |
| string | No | Details of the IP addresses of the DNS servers that correspond to the enterprise AD system. | 127.0.*.* | |
| SubDomainDnsAddress | array | No | The DNS address of the subdomain in the enterprise AD domain. You can specify only one DNS address. If you configure | |
| string | No | The DNS address of the subdomain in the enterprise AD domain. | 127.0.*.* | |
| AdHostname | string | No | The hostname of the domain controller. The hostname must comply with the naming conventions for hostnames in Windows. | beijing-ad01 |
| OUName | string | No | The name of the organizational unit (OU) in the AD domain. You can call the ListUserAdOrganizationUnits operation to obtain OUs. | oldad.com/Domain Controllers |
| BackupDns | string | No | The DNS address of the backup domain controller. | 192.168.2.100 |
| BackupDCHostname | string | No | The hostname of the backup domain controller. | dc002 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-06-26 | The request parameters of the API has changed | View Change Details |
| 2021-08-19 | The request parameters of the API has changed | View Change Details |