Adding a Site

Function

Queries site information.

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:add	Write	-	workspace:AccessMode	-	eip:bandwidths:create eip:publicIps:create elb:healthmonitors:create elb:healthmonitors:show elb:listeners:create elb:listeners:update elb:listeners:show elb:listeners:list elb:loadbalancers:create elb:loadbalancers:update elb:loadbalancers:show elb:members:create elb:members:list elb:members:update elb:pools:create elb:pools:update elb:pools:show vpc:ports:create vpc:ports:delete vpc:securityGroupRules:create vpc:securityGroupRules:delete vpc:securityGroupRules:get vpc:securityGroups:create vpc:subnets:get vpc:subnets:update vpc:vpcs:get vpcep:endpoints:create vpcep:endpoints:get

URI

POST /v2/{project_id}/sites

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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
site_configs	Yes	Array of SiteConfigsRequest objects	Site configuration information.

**Table 3** SiteConfigsRequest
Parameter	Mandatory	Type	Description
availability_zone	No	String	AZ used for subscribing to service resources.
network_config	Yes	NetworkConfigReq object	Network configuration.
access_config	Yes	AccessConfigReq object	Access configuration.

**Table 4** NetworkConfigReq
Parameter	Mandatory	Type	Description
vpc_id	No	String	VPC ID.
subnet_ids	No	Array of strings	Network ID of the specified service subnet.

**Table 5** AccessConfigReq
Parameter	Mandatory	Type	Description
access_mode	Yes	String	Access mode. INTERNET: access through the 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.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
job_id	String	ID of the task for initializing a site.

Status code: 400

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

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

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

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

Status code: 500

**Table 11** 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 12** 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

POST /v2/fb2e5ec048384c8f9469d22db0037908/sites

{
  "site_configs" : [ {
    "availability_zone" : "string",
    "network_config" : {
      "vpc_id" : "string",
      "subnet_ids" : [ "string" ]
    },
    "access_config" : {
      "access_mode" : "string",
      "dedicated_cidrs" : "192.168.0.0/24;10.0.0.0/16"
    }
  } ]
}

Example Responses

Status code: 200

Queries site information.

{
  "job_id" : "string"
}

Status Codes

Status Code	Description
200	Queries site information.
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.