Configure a trust relationship for an enterprise AD office network with ConfigADConnectorTrust - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Configures a trust relationship for an AD office network. For office networks (formerly workspaces) that use the HDX protocol, you must configure conditional forwarders and trust relationships before the networks can function properly.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:ConfigADConnectorTrust

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the regions supported by Elastic Desktop Service.	cn-hangzhou
OfficeSiteId	string	Yes	The ID of the AD office network.	cn-hangzhou+dir-778418****
TrustKey	string	Yes	The trust password. This password is the one that you set when configuring the trust relationship (establishing a trust relationship with the Elastic Desktop Service ecd.acs domain) in the AD domain.	password123***
RdsLicenseDomain	boolean	No	Specifies whether to configure the trust password for the RDS License Domain of the AD office network. Valid values: true : Configures the trust password for the RDS License Domain of the AD office network. false : Configures the trust password for a regular AD office network.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotSupport.ProtocolType	The specified parameter ProtocolType is not support.	The specified parameter ProtocolType is not support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.