ModifyOfficeSiteAttribute-阿里云帮助中心

Modifies basic attributes of an office site (formerly a workspace), such as its name and whether to grant users local administrative permissions on their cloud computers.

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:ModifyOfficeSiteAttribute

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the regions where Elastic Desktop Service is available.	cn-hangzhou
OfficeSiteId	string	Yes	The ID of the office site.	cn-hangzhou+dir-882398****
DesktopAccessType	string	No	The method for connecting to cloud computers. Note VPC connections use Alibaba Cloud PrivateLink, a free service. If you set this parameter to VPC or Any, PrivateLink is automatically activated. Valid values: INTERNET : Allows you to connect to cloud computers over the Internet. This is the default value. VPC : Allows you to connect to cloud computers from a client within the VPC. Any : Allows you to connect over the Internet or from within a VPC. You can select the connection method on the client.	INTERNET
OfficeSiteName	string	No	The name of the office site. The name must be 2 to 255 characters long. The name must start with a letter or a Chinese character, and cannot start with http:// or https://. It can contain digits, colons (:), underscores (_), and hyphens (-). This parameter is optional.	test
NeedVerifyLoginRisk	boolean	No	Specifies whether to enable two-factor authentication. This parameter is applicable to only office sites that use convenience accounts. If enabled, the system performs a security check during logon. If the system detects a risk, it sends a verification code to the email address that is associated with the account. The user must enter the correct verification code to log on.	false
NeedVerifyZeroDevice	boolean	No	Specifies whether to enable device verification. This feature is available only for office sites that use convenience accounts.	false
EnableAdminAccess	boolean	No	Specifies whether to grant cloud computer users local administrative permissions. Valid values: true : Grants the permissions. This is the default value. false : Does not grant the permissions.	false
AuthorityHost	string	No
TenantId	string	No
DomainName	string	No
ClientId	string	No
ClientSecret	string	No
VSwitchId	array	No
	string	No

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.