Esta página ainda não está disponível no idioma selecionado. Estamos trabalhando para adicionar mais opções de idiomas. Agradecemos sua compreensão.
Queries Huawei Cloud Workspace details
Function
Queries Huawei Cloud Workspace details.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v2/{project_id}/workspaces
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Content-Type |
Yes |
String |
MIME type of the request body. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Unique ID. |
is_global |
Boolean |
Whether the enabled service is a global service. |
ad_domains |
AdInfo object |
Domain information. |
vpc_id |
String |
VPC ID. |
vpc_name |
String |
VPC name. |
access_mode |
String |
Access mode.
|
adn_conflict_network |
String |
Conflicted CIDR blocks in ADN network access. Multiple CIDR blocks are separated by semicolons (;). A maximum of 50 CIDR blocks are allowed. |
dedicated_subnets |
String |
Direct Connect access CIDR. This parameter is returned only when access_mode is set to DEDICATED or BOTH. |
dedicated_access_address |
String |
Direct Connect access address. This parameter is returned only when access_mode is set to DEDICATED or BOTH. |
internet_access_address |
String |
Internet access address. This parameter is returned only when access_mode is set to INTERNET or BOTH. |
internet_access_port |
String |
Internet access port. |
status |
String |
Huawei Cloud Workspace service status.
|
access_status |
String |
Status of the task for switching between the Internet and Direct Connect.
|
subnet_ids |
Array of SubnetInfo objects |
Service subnet. You can specify the returned network ID to subscribe to a desktop. |
vpc_config_infos |
Array of VpcConfigInfo objects |
VPC configuration information list. |
management_subnet_cidr |
String |
Subnet CIDR of the management component. |
infrastructure_security_group |
SecurityGroup object |
After the service is subscribed, a management component security group is created in the specified VPC. |
desktop_security_group |
SecurityGroup object |
After the service is subscribed, a desktop security group is created in the specified VPC. |
closable |
Boolean |
Whether the service can be unsubscribed. |
config_status |
String |
Configuration status.
|
progress |
String |
Progress of subscribing to or unsubscribing from the service. The value is a percentage, for example, 100%. |
job_id |
String |
ID of the task for subscribing to or unsubscribing from the service. |
fail_code |
Integer |
Error code. |
fail_reason |
String |
Failure cause. |
enterprise_id |
String |
Enterprise ID. |
enterprise_project_id |
String |
Enterprise project ID. |
is_send_email |
Boolean |
Whether to send a notification email upon desktop unsubscription. |
authorized_collect_log |
Boolean |
Indicates whether to authorize log collection. |
authorized_hda_upgrade |
Boolean |
Indicates whether to authorize the hda upgrade. |
site_configs |
Array of SiteConfigsResponse objects |
Site configuration information. |
dc_vnc_ip |
String |
User-defined Direct Connect VNC address. |
is_authorized_install_agent |
Boolean |
Whether to grant the permission for automatic agent plug-in installation on desktops. |
is_support_ipv6 |
Boolean |
Whether IPv6 is supported. |
enable_user_create_snapshot |
Boolean |
Whether to authorize end tenants to create snapshots. |
Parameter |
Type |
Description |
---|---|---|
domain_type |
String |
Domain type.
|
domain_name |
String |
Domain name. This parameter is valid when domain_type is set to LOCAL_AD. |
domain_admin_account |
String |
Domain administrator account. This parameter is valid when domain_type is set to LOCAL_AD. |
active_domain_name |
String |
Name of the primary domain controller. This parameter is valid when domain_type is set to LOCAL_AD. |
active_domain_ip |
String |
IP address of the primary domain controller. This parameter is valid when domain_type is set to LOCAL_AD. |
standby_domain_name |
String |
Name of the backup domain controller. This parameter is valid when domain_type is set to LOCAL_AD. |
standby_domain_ip |
String |
IP address of the backup domain controller. This parameter is valid when domain_type is set to LOCAL_AD. |
active_dns_ip |
String |
IP address of the primary DNS server. This parameter is valid when domain_type is set to LOCAL_AD. |
standby_dns_ip |
String |
IP address of the standby DNS server. This parameter is valid when domain_type is set to LOCAL_AD. |
delete_computer_object |
String |
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. |
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. |
Parameter |
Type |
Description |
---|---|---|
site_id |
String |
Site ID. |
site_type |
String |
Configuration status. - CENTER: center initialization - IES: edge initialization |
site_name |
String |
Site name. |
status |
String |
Huawei Cloud Workspace service status. - PREPARING: The service is ready for subscription. - SUBSCRIBING: The service is being subscribed. - SUBSCRIBED: The service has been subscribed. - SUBSCRIPTION_FAILED: The service cannot be subscribed. - DEREGISTERING: The service is being unsubscribed. - DEREGISTRATION_FAILED: The service cannot be unsubscribed. - CLOSED: The service has been unsubscribed and is not subscribed. |
access_status |
String |
Status of the task for switching between the Internet and Direct Connect. - init: initial status after the service is enabled. - available: The task has been successfully executed and is restored to the normal state. - internetOpening: Internet access is being enabled. - dedicatedOpening: indicates that Direct Connect is being enabled. - internetOpenFailed: Failed to enable Internet access. - dedicatedOpenFailed: Failed to enable Direct Connect. - openSuccess: The access mode is successfully enabled. - internetClosing: Internet access is being disabled. - dedicatedClosing: The private line is being disabled. - internetCloseFailed: Failed to disable the Internet access mode. - dedicatedCloseFailed: Failed to disable the private line access mode. - closeSuccess: The access mode is successfully disabled. - internetAccessPortModifying: The Internet access port is being changed. - internetAccessPortModifyFailed: The port fails to be changed. |
config_status |
String |
Configuration status. - 0: The service has been subscribed and connected to the AD. - 1: The service has been subscribed but the AD configuration failed. - 2: The service has been subscribed but other errors occurred after the AD configuration failed. - 3: The service has been subscribed but the AD is not connected. |
infrastructure_security_group |
SecurityGroup object |
After the service is subscribed, a management component security group is created in the specified VPC. |
desktop_security_group |
SecurityGroup object |
After the service is subscribed, a desktop security group is created in the specified VPC. |
availability_zones |
Array of strings |
AZ used for subscribing to service resources. |
job_id |
String |
ID of the task for subscribing to or unsubscribing from the service. |
progress |
String |
The progress of initializing services or cleaning up resources, formatted as 100%. |
fail_code |
Integer |
Error code. |
fail_reason |
String |
Failure cause. |
network_config |
NetworkConfig object |
Network information. |
access_config |
AccessConfig object |
Access information. |
closable |
Boolean |
Whether the service can be unsubscribed. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Security group ID. |
name |
String |
Security group name. |
Parameter |
Type |
Description |
---|---|---|
vpc_id |
String |
VPC ID. |
vpc_name |
String |
VPC name. |
subnet_ids |
Array of strings |
Service subnet. You can specify the returned network ID to subscribe to a desktop. |
management_subnet_cidr |
String |
The subnet segment occupied by the backend management component. |
management_node_subnet_id |
String |
The subnet ID occupied by the managed node among the business subnets returned by subnet_ids. |
vpc_config_infos |
Array of VpcConfigInfo objects |
VPC configuration information list. |
Parameter |
Type |
Description |
---|---|---|
used_subnet_ids |
Array of strings |
Information about used subnets. |
vpc_id |
String |
VPC ID. |
subnet_ids |
Array of strings |
Subnet IDs |
default_access_vpc |
Boolean |
Whether the default access VPC is used. |
Parameter |
Type |
Description |
---|---|---|
access_mode |
String |
Access mode. - INTERNET: access through Internet - DEDICATED: access through Direct Connect - BOTH: access through Internet or Direct Connect |
internet_access_address |
String |
Internet access address. This parameter is returned only when access_mode is set to INTERNET or BOTH. |
internet_access_port |
String |
Internet access port. |
dedicated_access_address |
String |
Direct Connect access address. This parameter is returned only when access_mode is set to DEDICATED or BOTH. |
dedicated_access_standby_address |
Array of strings |
Dedicated line access backup address, this parameter will only be returned when the dedicated line backup route is activated. |
standby_address_result_code |
String |
Dedicated Line Backup Line Failure Error Code. |
dedicated_cidrs |
String |
Dedicated Line Access Network Segment. The access mode includes the dedicated line method as an optional selection. Multiple network segment information should be separated by semicolons, and the list length should not exceed 5. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
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 /v2/29dfe82ada564ac2b927e1ff036d9a9b/workspaces
Example Responses
Status code: 200
Response to the request for querying Huawei Cloud Workspace details.
{
"id" : "8aa1908f74824d8701748bf039600065",
"status" : "SUBSCRIBED",
"config_status" : "0",
"closable" : false,
"ad_domains" : {
"domain_type" : "LOCAL_AD",
"domain_admin_account" : "vdsadmin",
"active_domain_name" : "ecs-ad.vdesktop.com",
"active_domain_ip" : "192.168.0.131",
"standby_domain_name" : "",
"standby_domain_ip" : "",
"active_dns_ip" : "192.168.0.131",
"standby_dns_ip" : "",
"domain_name" : "vdesktop.com",
"use_ldaps" : true,
"tls_config" : {
"cert_start_time" : "2022-01-25T09:24:27",
"cert_end_time" : "2023-01-25T09:34:27"
}
},
"vpc_id" : "fd3b4069-ac1e-45d2-ba27-4c18cd692d26",
"vpc_name" : "vpc-be75",
"dedicated_access_address" : "https://192.168.0.53",
"dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16",
"internet_access_address" : "https://172.16.25.134",
"internet_access_port" : "443",
"access_mode" : "BOTH",
"subnet_ids" : [ {
"subnet_id" : "5dee0216-2260-47c2-9368-98a27d910e55"
} ],
"management_subnet_cidr" : "192.168.0.0/24",
"infrastructure_security_group" : {
"id" : "ffba6eda-5170-4343-b8a3-c306e0f21c88",
"name" : "WorkspaceManagerSecurityGroup"
},
"desktop_security_group" : {
"id" : "04abbdf6-e848-4c90-bdb1-6de856fa8a34",
"name" : "WorkspaceUserSecurityGroup"
},
"progress" : "100%",
"access_status" : "openSuccess",
"is_send_email" : true,
"authorized_collect_log" : false,
"authorized_hda_upgrade" : false,
"vpc_config_infos" : [ {
"vpc_id" : "04abbdf6-e848-4c90-bdb1-6de856favpc1",
"subnet_ids" : [ "04abbdf6-e848-4c90-bdb1-6de85subnet1" ],
"default_access_vpc" : true
}, {
"vpc_id" : "04abbdf6-e848-4c90-bdb1-6de856favpc2",
"subnet_ids" : [ "04abbdf6-e848-4c90-bdb1-6de85subnet3" ]
} ]
}
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for querying Huawei Cloud Workspace details. |
400 |
The request cannot be understood by the server due to malformed syntax. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resource found. |
500 |
An internal service error occurred. For details about the error code, see the error code description. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot