使用DescribeOfficeSites查詢辦公網路屬性-無影雲電腦企業版-阿里雲 - Elastic Desktop Service

查詢辦公網路的所有屬性，包括ID、名稱、狀態、建立時間等。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecd:DescribeOfficeSites

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地域 ID。可以呼叫 DescribeRegions 取得無影雲電腦支援的地域列表。	cn-hangzhou
OfficeSiteType	string	否	辦公網路的帳號體系類型。枚舉值： SIMPLE : 便捷帳號。 AD_CONNECTOR : 企業 AD 帳號。	SIMPLE
MaxResults	integer	否	分頁查詢時每頁行數。最大值：100。預設值：10。	10
NextToken	string	否	下一個查詢開始的 Token。	caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteId	array	否	辦公網路 ID。可設定 1~100 個。	cn-hangzhou+dir-363353****
	string	否	辦公網路 ID。	cn-hangzhou+dir-363353****
Status	string	否	辦公網路狀態。枚舉值： REGISTERING : 註冊中。 DEREGISTERING : 取消中。 REGISTERED : 已註冊。 NEEDCONFIGTRUST : 需要設定信任關係。 CONFIGTRUSTFAILED : 設定信任關係失敗。 DEREGISTERED : 已取消。 ERROR : 設定錯誤。 CONFIGTRUSTING : 設定信任關係中。 NEEDCONFIGUSER : 需要設定使用者。	REGISTERED
SecurityProtection	string	否	辦公網路安全防護設定。枚舉值： SASE : SASE OFF : 關閉。	SASE
VpcId	string	否	共享型雲電腦的辦公網路所在的 VPC ID。說明該參數暫未開放使用。	vpc-uf6w8u60n8xbkg5el****
AccountType	string	否	帳號類型。	SIMPLE

返回參數

名稱	類型	描述	樣本值
	object	返回資訊集合。
NextToken	string	下一個查詢開始的 Token。NextToken 為空表示沒有下一個。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	請求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	查詢結果總數。	20
OfficeSites	array<object>	辦公網路資訊集合。
	array<object>	辦公網路物件。
Status	string	辦公網路狀態。枚舉值： REGISTERING : 註冊中。 DEREGISTERING : 取消中。 REGISTERED : 已註冊。 NEEDCONFIGTRUST : 需要設定信任關係。 CONFIGTRUSTFAILED : 設定信任關係失敗。 DEREGISTERED : 已取消。 ERROR : 設定錯誤。 CONFIGTRUSTING : 設定信任關係中。 NEEDCONFIGUSER : 需要設定使用者。	REGISTERED
CreationTime	string	辦公網路建立時間。時間格式為 ISO 8601 標準（UTC 時間）。	2021-05-06T05:58Z
VpcId	string	安全辦公網路 VPC ID。	vpc-uf6tz5k67puge5jn8****
VpcType	string	VPC 的使用方式。枚舉值： Basic : 基礎型。 Customized : 客製化型。 Standard : 標準型。	Basic
EnableAdminAccess	boolean	是否為使用雲端電腦的使用者賦予本機管理員權限。枚舉值： true : 賦予本機管理員權限 [預設值] false : 不賦予本機管理員權限。	true
EnableCrossDesktopAccess	boolean	是否開啟辦公網路內雲端電腦互通。開啟後，同一個辦公網路內的雲端電腦之間可以實現相互存取彼此的網路。	false
DesktopVpcEndpoint	string	VPC 連線雲端電腦時所使用的終端節點。	http://ep-bp1s2vmbj55r5rzc**.epsrv-bp1pcfhpwvlpny01**.cn-hangzhou.privatelink.aliyuncs.com
DesktopAccessType	string	連線雲端電腦時允許使用的連入方式。說明 VPC 連線方式依賴於阿里雲私網連線 PrivateLink 服務，該服務不收取費用。該參數設定為`VPC`或者`Any`時，系統將自動為您啟用私網連線服務。枚舉值： INTERNET : 只允許用戶端透過公網連線雲端電腦。[預設值] VPC : 只允許處於 VPC 網路內的用戶端連線雲端電腦。 ANY : 不限制方式。使用用戶端連線雲端電腦時可以自行選擇連線方式。	INTERNET
SsoEnabled	boolean	是否開啟單一登入 SSO。	false
CidrBlock	string	辦公網路 VPC 所包含的 IPv4 網段。	47.100.XX.XX
Bandwidth	integer	公網頻寬峰值。可能值：0~1000Mbps。如果為空或 0，則表示沒有啟用網際網路存取。	10
TrustPassword	string	說明該參數暫未開放使用。	To be hidden.
Name	string	辦公網路名稱。同一地域下，該名稱唯一。	研發部辦公網路
EnableInternetAccess	boolean	是否已啟用公網存取功能。	false
DomainPassword	string	網域管理員的使用者密碼。	testPassword
CustomSecurityGroupId	string	安全性群組 ID。	sg-bp1ce64o4g9mdf5u****
OuName	string	對接 AD 網域中的組織單位。	example.com/Domain Controllers
DomainUserName	string	網域管理員的使用者名稱。	Administrator
SubDomainName	string	AD 子網域 DNS 的使用者名稱。	testSubDnsUserName
OfficeSiteId	string	辦公網路 ID。	cn-hangzhou+dir-363353****
CenId	string	雲端企業網執行個體 ID。	cen-3gwy16dojz1m65****
CenAttachStatus	string	雲端企業網 CEN 的狀態。	attached
MfaEnabled	boolean	是否開啟多重要素驗證 MFA。	false
NetworkPackageId	string	網際網路存取包 ID。	np-amtp8e8q1o9e4****
DnsUserName	string	DNS 使用者名稱。	testDnsUserName
OfficeSiteType	string	辦公網路帳號體系類型。枚舉值： SIMPLE : 便捷帳號。 AD_CONNECTOR : 企業 AD 帳號。	AD_CONNECTOR
ADConnectors	array<object>	AD Connector 的資訊集合。
	object	AD Connector 物件。
ConnectorStatus	string	AD Connector 的狀態。枚舉值： CONNECT_ERROR : 連線錯誤。 RUNNING : 執行中。 CONNECTING : 連線中。需要完成 AD 網域設定。 EXPIRED : 欠費過期。 CREATING : 建立中。	RUNNING
VSwitchId	string	AD Connector 所在網路對應的交換器 ID。	vsw-bp19ocz3erfx15uon****
ADConnectorAddress	string	AD Connector 的連線位址。	172.24..
TrustKey	string	設定 AD 信任關係時設定的信任密碼。	password123***
NetworkInterfaceId	string	AD Connector 掛載的網路介面卡 ID。	eni-bp1i4wx78lgosrj6****
Specification	string	AD Connector 規格。枚舉值： 1 : 通用型。 2 : 進階型。	1
Logs	array<object>	註冊日誌資訊。
	object	註冊日誌物件。
Step	string	日誌資訊對應的步驟。	CREATE_CONNECTOR
Message	string	日誌詳細資訊。	code:success \| message:Create Connector complete
TimeStamp	string	日誌列印時間。時間格式為 ISO 8601 標準（UTC 時間）。	2021-05-12T09:42Z
Level	string	日誌層級。枚舉值： ERROR : 錯誤。 INFO : 資訊。 WARN : 警告。	INFO
VSwitchIds	array	交換器 ID 陣列。
	string	交換器 ID。	vsw-bp19ocz3erfx15uon****
FileSystemIds	array	NAS 檔案系統 ID 陣列。
	string	NAS 檔案系統 ID。	["05b534****"]
SubDnsAddress	array	AD 子網域的 DNS 位址陣列。
	string	AD 子網域的 DNS 位址。	["172.24.XX.XX"]
DnsAddress	array	AD 網域對應的 DNS 位址陣列。
	string	AD 網域對應的 DNS 位址。	["172.24.XX.XX"]
CustomDnsAddress	array	自訂 DNS 位址陣列。
	string	自訂 DNS 位址。	["172.24.XX.XX"]
NeedVerifyLoginRisk	boolean	僅適用於便捷帳號辦公網路，表示登入時是否需要二次驗證。如果開啟了登入二次驗證，則便捷使用者登入用戶端時，系統將偵測登入帳號是否有安全風險。如果有風險，系統將傳送驗證碼到該帳號關聯的信箱，便捷使用者使用驗證碼驗證通過後才能登入用戶端。	false
DesktopCount	integer	已建立的雲端電腦數量。	1
TotalEdsCount	integer	雲端電腦數量。	0
TotalEdsCountForGroup	integer	共用型雲端電腦內的雲端電腦數量。	0
NeedVerifyZeroDevice	boolean	是否開啟可信裝置驗證。枚舉值： true : 開啟。 false : 未開啟。	true
CloudBoxOfficeSite	boolean	是否為雲盒辦公網路。枚舉值： true : 雲盒辦公網路。 false : 公網辦公網路。	true
SsoType	string	SSO 類型。枚舉值： SAML : SAML	SAML
ProtocolType	string	協定類型。枚舉值： HDX : HDX 協定。 ASP : 阿里雲自研 ASP 協定。	ASP
AdHostname	string	網域控制站主機名稱。必須符合 Windows 主機命名規範。	beijing-ad01
RdsLicenseStatus	string	RDS 授權的狀態。	2
RdsLicenseAddress	string	RDS 授權的 IP 位址。	47.100.XX.XX
RdsLicenseDomainName	string	RDS 授權所在的網域名稱。	example.com
BackupDns	string	備用網域控制站 DNS 位址。	172.24.XX.XX
BackupDCHostname	string	備用網域控制站主機名稱。	beijing-ad02
EnableServiceRoute	boolean	是否開啟雲端服務路由存取管控。	false
SubnetMode	string	辦公網路子網路模式。枚舉值： 0 : 跟隨辦公網路模式。 1 : 半管控模式。	0
SecurityProtection	string	辦公網路安全防護設定。枚舉值： SASE : SASE OFF : 關閉。	SASE
CustomAccessPoint	string	自訂接入閘道位址。	gw-****.com
ResourceAmounts	array<object>	資源數量清單。
	object
resourceType	string	資源類型。枚舉值： desktop : 雲端電腦。 desktopGroup : 共用型雲端電腦。	desktop
amount	integer	資源數量。	1
TotalResourceAmount	integer	網路卡總數。	1
NmVersion	string	網路版本。新版支援無影雲端應用等產品。枚舉值： DEFAULT : 舊版。 NM : 新版。	NM
AcceleratorId	string	全球加速執行個體 ID。	ga-bp1astu3yrplkzoo2****
LdapUrl	string	LDAP 服務的存取位址。	ldap://192.168.0.10:389
IsLdap	boolean	是否為 LDAP 目錄。
DomainName	string	企業 AD 的網域名稱。	example.com
AccountType	string	帳號類型。	SIMPLE
AuthorityHost	string	身分驗證服務的 Authority 位址。	https://login.microsoftonline.com
TenantId	string	身分提供者的租戶 ID。	72f988bf-86f1-41af-91ab-2d7cd011****
ClientId	string	身分提供方應用程式註冊的用戶端 ID。	a2c8f7e4-1b3d-4c5e-9f0a-6d7b8c9e****
EnvType	string	環境類型，不對外開放。	Private
VplVersion	string	工作區網路元件（VPL）的版本。	2.0.0
ClientSecret	string	身分提供方應用程式註冊的用戶端金鑰。	sct-9f3e2d1c****
Eid	string	企業 ID（EID）。	e-1234abcd****
AccessAttribute	string	辦公網路（工作區）的存取屬性。	Private
BasicInternetType	string	基礎頻寬類型。	basic_plus

樣本

正常返回樣本

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 20,
  "OfficeSites": [
    {
      "Status": "REGISTERED",
      "CreationTime": "2021-05-06T05:58Z",
      "VpcId": "vpc-uf6tz5k67puge5jn8****",
      "VpcType": "Basic",
      "EnableAdminAccess": true,
      "EnableCrossDesktopAccess": false,
      "DesktopVpcEndpoint": "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
      "DesktopAccessType": "INTERNET",
      "SsoEnabled": false,
      "CidrBlock": "47.100.XX.XX",
      "Bandwidth": 10,
      "TrustPassword": "To be hidden.",
      "Name": "研發部辦公網路",
      "EnableInternetAccess": false,
      "DomainPassword": "testPassword",
      "CustomSecurityGroupId": "sg-bp1ce64o4g9mdf5u****",
      "OuName": "example.com/Domain Controllers",
      "DomainUserName": "Administrator",
      "SubDomainName": "testSubDnsUserName",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "CenId": "cen-3gwy16dojz1m65****",
      "CenAttachStatus": "attached",
      "MfaEnabled": false,
      "NetworkPackageId": "np-amtp8e8q1o9e4****",
      "DnsUserName": "testDnsUserName\t",
      "OfficeSiteType": "AD_CONNECTOR",
      "ADConnectors": [
        {
          "ConnectorStatus": "RUNNING",
          "VSwitchId": "vsw-bp19ocz3erfx15uon****",
          "ADConnectorAddress": "172.24.*.*",
          "TrustKey": "password123***",
          "NetworkInterfaceId": "eni-bp1i4wx78lgosrj6****",
          "Specification": "1"
        }
      ],
      "Logs": [
        {
          "Step": "CREATE_CONNECTOR",
          "Message": "code:success | message:Create Connector complete",
          "TimeStamp": "2021-05-12T09:42Z",
          "Level": "INFO"
        }
      ],
      "VSwitchIds": [
        "vsw-bp19ocz3erfx15uon****"
      ],
      "FileSystemIds": [
        "[\"05b534****\"]"
      ],
      "SubDnsAddress": [
        " [\"172.24.XX.XX\"]"
      ],
      "DnsAddress": [
        " [\"172.24.XX.XX\"]"
      ],
      "CustomDnsAddress": [
        " [\"172.24.XX.XX\"]"
      ],
      "NeedVerifyLoginRisk": false,
      "DesktopCount": 1,
      "TotalEdsCount": 0,
      "TotalEdsCountForGroup": 0,
      "NeedVerifyZeroDevice": true,
      "CloudBoxOfficeSite": true,
      "SsoType": "SAML",
      "ProtocolType": "ASP",
      "AdHostname": "beijing-ad01",
      "RdsLicenseStatus": "2",
      "RdsLicenseAddress": "47.100.XX.XX",
      "RdsLicenseDomainName": "example.com",
      "BackupDns": "172.24.XX.XX",
      "BackupDCHostname": "beijing-ad02",
      "EnableServiceRoute": false,
      "SubnetMode": "0",
      "SecurityProtection": "SASE",
      "CustomAccessPoint": "gw-****.com",
      "ResourceAmounts": [
        {
          "resourceType": "desktop",
          "amount": 1
        }
      ],
      "TotalResourceAmount": 1,
      "NmVersion": "NM",
      "AcceleratorId": "ga-bp1astu3yrplkzoo2****",
      "LdapUrl": "ldap://192.168.0.10:389",
      "IsLdap": false,
      "DomainName": "example.com",
      "AccountType": "SIMPLE",
      "AuthorityHost": "https://login.microsoftonline.com",
      "TenantId": "72f988bf-86f1-41af-91ab-2d7cd011****",
      "ClientId": "a2c8f7e4-1b3d-4c5e-9f0a-6d7b8c9e****",
      "EnvType": "Private",
      "VplVersion": "2.0.0",
      "ClientSecret": "sct-9f3e2d1c****",
      "Eid": "e-1234abcd****",
      "AccessAttribute": "Private",
      "BasicInternetType": "basic_plus"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidDirectoryId.Missing	The specified parameter DirectoryId is missing.	缺少參數 DirectoryId。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。