Changing the Site Access Mode

Function

Changes the site access mode.

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:sites:updateAccessMode	Write	-	workspace:AccessMode	-	eip:bandwidths:create eip:bandwidths:delete eip:publicIps:create eip:publicIps:delete eip:publicIps:disassociateInstance elb:healthmonitors:create elb:healthmonitors:delete elb:healthmonitors:show elb:listeners:create elb:listeners:delete elb:listeners:update elb:listeners:show elb:loadbalancers:create elb:loadbalancers:delete elb:loadbalancers:update elb:loadbalancers:show elb:members:create elb:members:delete elb:members:list elb:members:update elb:pools:create elb:pools:delete elb:pools:update elb:pools:show vpc:subnets:get vpc:subnets:update vpc:vpcs:get vpcep:endpoints:create vpcep:endpoints:delete vpcep:endpoints:get

URI

PUT /v2/{project_id}/sites/{site_id}/access-mode

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
site_id	Yes	String	Site ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
access_mode	No	String	Access mode. INTERNET: access through Internet DEDICATED: access through Direct Connect BOTH: both access modes supported
dedicated_cidrs	No	String	CIDR blocks in Direct Connect network access. Multiple CIDR blocks are separated by semicolons (;). A maximum of 5 CIDR blocks are allowed.
apply_shared_vpc_dedicated_param	No	ApplySharedVpcDedicatedParam object	Input parameter of the shared VPC Direct Connect.

**Table 3** ApplySharedVpcDedicatedParam
Parameter	Mandatory	Type	Description
address	No	String	Shared VPC Direct Connect address specified by the tenant.
port	No	Integer	Shared VPC Direct Connect address port specified by the tenant.
availability_zone	No	Array of strings	AZ used for subscribing to service resources. By default, two AZs are randomly used.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.

Status code: 400

**Table 5** 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 6** 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 7** 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 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: 500

**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: 503

**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.

Example Requests

PUT /v2/fb2e5ec048384c8f9469d22db0037908/sites/fd5225ef-89f5-4921-9ab0-08fdbdd696fe/access-mode

{
  "access_mode" : "string",
  "dedicated_cidrs" : "192.168.0.0/24;10.0.0.0/16",
  "apply_shared_vpc_dedicated_param" : {
    "address" : "string",
    "port" : 65535,
    "availability_zone" : [ "string" ]
  }
}

Example Responses

Status code: 200

Response to the request for changing the site access mode.

{
  "job_id" : "string"
}

Status Codes

Status Code	Description
200	Response to the request for changing the site access mode.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.
503	Service unavailable.