文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 云办公服务/ 查询域控的配置信息 - ShowDomainsNew
更新时间:2026-05-21 GMT+08:00

查询域控的配置信息 - ShowDomainsNew

功能介绍

查询域控的配置信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/domains

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

auth_type

String

认证类型。 - OPEN_API:UOS域控。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

uos_domain_list

Array of UosDomainInfo objects

统信域控列表。

domain_infos

Array of AdDomain objects

域信息。

表4 UosDomainInfo

参数

参数类型

描述

auth_config_id

String

认证配置id。

id

String

域控id。

type

String

对接协议类型。

domain_name

String

统信域控名称。

username

String

域管理员。

main_dc_address

String

域管平台地址。

open_interface_address

String

域管开放接口地址。

open_interface_domain_name

String

域管开放接口域名。

internal_service_address

String

域管内部服务地址。

app_cert_id

String

客户端证书公钥id。

app_cert_start_time

String

客户端证书公钥有效期起始时间。

app_cert_end_time

String

客户端证书公钥有效期结束时间。

openapi_ca_cert_id

String

服务端CA id。

openapi_ca_cert_start_time

String

服务端CA有效期起始时间。

openapi_ca_cert_end_time

String

服务端CA有效期结束时间。

表5 AdDomain

参数

参数类型

描述

id

String

域id。

domain_type

String

域类型。

  • LITE_AS:本地认证。

  • LOCAL_AD:本地AD。

说明:域类型为“LOCAL_AD”时,请确保所选VPC网络与AD所属网络可连通。

domain_name

String

域名称。域类型为LOCAL_AD时需要配置。

域名必须为AD服务器上已经存在的域名,且长度不超过55。

domain_admin_account

String

域管理员账号。域类型为LOCAL_AD时需要配置。

必须为AD服务器上已经存在的域管理员账号。

domain_password

String

域管理员账号密码。域类型为LOCAL_AD时需要配置。

active_domain_ip

String

主域控制器IP地址。域类型为LOCAL_AD时需要配置。

active_domain_name

String

主域控制器名称。域类型为LOCAL_AD时需要配置。

standby_domain_ip

String

备域控制器IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。

standby_domain_name

String

备域控制器名称。域类型为LOCAL_AD时且配置备节点时需要配置。

active_dns_ip

String

主DNS IP地址。域类型为LOCAL_AD时需要配置。

standby_dns_ip

String

备DNS IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。

delete_computer_object

Integer

是否在删除桌面的同时删除AD上对应的计算机对象,0代表不删除,1代表删除。

use_ldaps

Boolean

是否开启LDAPS。

tls_config

TlsConfig object

TLS信息。

cba_enabled

Boolean

是否开启智能卡认证。

certificate_id

String

智能卡证书id。

domain_controllers

Array of DomainController objects

域控制器信息列表。有值时,active_domain_name、active_domain_ip、standby_domain_name、standby_domain_ip无效。

表6 TlsConfig

参数

参数类型

描述

cert_pem

String

pem内容, 有则更新,无则上传。查询不返回。

cert_start_time

String

证书生效开始时间,时间参考样例 2022-01-25T09:24:27。

cert_end_time

String

证书生效截止时间,时间参考样例 2022-01-25T09:24:27。

表7 DomainController

参数

参数类型

描述

dc_ip

String

域控制器IP地址。

dc_name

String

域控制器名称。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

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

响应示例

状态码:200

查询域控的配置信息响应。

{
  "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"
  } ]
}

状态码

状态码

描述

200

查询域控的配置信息响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误,具体返回错误码请参见错误码说明。

错误码

请参见错误码