Help Center/ Workspace/ API Reference/ Workspace APIs/ Huawei Cloud Workspace/ Querying Domain Controller Configuration
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Domain Controller Configuration

Function

Queries domain controller configuration.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v3/{project_id}/domains

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

auth_type

No

String

Authentication type. - OPEN_API: UOS domain controller

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

uos_domain_list

Array of UosDomainInfo objects

UOS domain controller list.

domain_infos

Array of AdDomain objects

Domain information.
Table 4 UosDomainInfo

Parameter

Type

Description

auth_config_id

String

Authentication configuration ID.

id

String

Domain controller ID.

type

String

Interconnection protocol type.

domain_name

String

UOS domain controller name.

username

String

Domain administrator.

main_dc_address

String

Domain management platform address.

open_interface_address

String

Address of the open interface of the domain management system.

open_interface_domain_name

String

Domain name of the open interface of the domain management system.

internal_service_address

String

Internal service address of the domain management system.

app_cert_id

String

Public key ID of the client certificate.

app_cert_start_time

String

Start time of the validity period of the client certificate's public key.

app_cert_end_time

String

End time of the validity period of the client certificate's public key.

openapi_ca_cert_id

String

Server CA ID.

openapi_ca_cert_start_time

String

Start time of the validity period of the server CA.

openapi_ca_cert_end_time

String

End time of the validity period of the server CA.
Table 5 AdDomain

Parameter

Type

Description

id

String

Domain ID.

domain_type

String

Domain type.

  • LITE_AS: local authentication

  • LOCAL_AD: local AD

When domain_type is set to LOCAL_AD, ensure that the selected VPC can be connected to the network to which the AD belongs.

domain_name

String

Domain name. This parameter is mandatory when domain type is set to LOCAL_AD.

The domain name must be an existing domain name on the Windows AD server and can contain a maximum of 55 characters.

domain_admin_account

String

Domain administrator account. This parameter is mandatory when domain type is set to LOCAL_AD.

The account must be an existing domain administrator account on the Windows AD server.

domain_password

String

Domain administrator account and password. This parameter is mandatory when domain type is set to LOCAL_AD.

active_domain_ip

String

Primary domain controller IP address. This parameter is mandatory when domain type is set to LOCAL_AD.

active_domain_name

String

Primary domain controller name. This parameter is mandatory when domain type is set to LOCAL_AD.

standby_domain_ip

String

Backup domain controller IP address. This parameter is mandatory when domain type is set to LOCAL_AD and the standby node is configured.

standby_domain_name

String

Backup domain controller name. This parameter is mandatory when domain type is set to LOCAL_AD and the standby node is configured.

active_dns_ip

String

Primary DNS IP address. This parameter is mandatory when domain type is set to LOCAL_AD.

standby_dns_ip

String

Standby DNS IP address. This parameter is mandatory when domain type is set to LOCAL_AD and the standby node is configured.

delete_computer_object

Integer

Whether to delete the corresponding computer object from the AD when deleting the desktop. The value 0 indicates that the computer object is not deleted, and the value 1 indicates that the computer object is deleted.

use_ldaps

Boolean

Whether to enable LDAPS.

tls_config

TlsConfig object

TLS information.

cba_enabled

Boolean

Whether to enable smartcard authentication.

certificate_id

String

Smartcard certificate ID.

domain_controllers

Array of DomainController objects

List of domain controllers. If this parameter is specified, the following parameters are invalid: active_domain_name, active_domain_ip, standby_domain_name, and standby_domain_ip.
Table 6 TlsConfig

Parameter

Type

Description

cert_pem

String

PEM content. If the content exists, update it. Otherwise, upload it. The query result is not returned.

cert_start_time

String

Time when the certificate starts to take effect, for example, 2022-01-25T09:24:27.

cert_end_time

String

Time when the certificate expires, for example, 2022-01-25T09:24:27.
Table 7 DomainController

Parameter

Type

Description

dc_ip

String

IP address of the domain controller.

dc_name

String

Name of the domain controller.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v3/29dfe82ada564ac2b927e1ff036d9a9b/third-domain-controller

Example Responses

Status code: 200

Response to the request for querying domain controller configurations.

{
  "uos_domain_list" : [ {
    "id" : "c711a46xxxxxxx7cf6da8800",
    "auth_config_id" : "string",
    "type" : "OPEN_API",
    "domain_name" : "UOS",
    "username" : "admin",
    "main_dc_address" : "https://127.0.0.1:4433",
    "open_interface_address" : "https://127.0.0.1:4434",
    "open_interface_domain_name" : "udcp-openapi.uniontech.com",
    "internal_service_address" : "https://127.0.0.1:4435",
    "app_cert_id" : "c711a46xxxxxxx7cf6da8800",
    "app_cert_start_time" : "2011-12-03T10:15:30",
    "app_cert_end_time" : "2012-12-03T10:15:30",
    "openapi_ca_cert_id" : "c711a46xxxxxxx7cf6da8800",
    "openapi_ca_cert_start_time" : "2011-12-03T10:15:30",
    "openapi_ca_cert_end_time" : "2012-12-03T10:15:30"
  } ]
}

Status Codes

Status Code

Description

200

Response to the request for querying domain controller configurations.

400

The request cannot be understood by the server due to malformed syntax.

401

Authorization failed.

403

No permissions.

404

Resources not found.

500

An internal service error occurred. For details, see the error code description.

Error Codes

See Error Codes.

Parent topic: Huawei Cloud Workspace