Updated on 2025-09-26 GMT+08:00

Creating an Instance

Function

This API is used to create an SWR Enterprise Edition instance.

Constraints

None.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of an SWR Enterprise Edition instance. The value can contain 3 to 64 characters, starting and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other.

description

No

String

Description of an SWR Enterprise Edition instance.

spec

Yes

String

Specifications of an SWR Enterprise Edition instance. Only swr.ee.professional is supported.

vpc_id

Yes

String

VPC ID.

subnet_id

Yes

String

Network ID of a subnet.

project_id

Yes

String

ID of the project where the VPC and subnet are.

charge_mode

Yes

String

Instance billing mode. Currently, the value can only be postPaid (pay-per-use billing).

enterprise_project_id

Yes

String

Enterprise project ID.

resource_tags

No

Array of resource_tags objects

Resource tag.

obs_encrypt

No

Boolean

Whether encryption is enabled for an OBS bucket. If encryption is enabled, you can specify the encryption algorithm based on encrypt_type.

encrypt_type

No

String

Encryption type of an OBS bucket. If this parameter is left empty, the AES-256 encryption algorithm is used. If this parameter is set to gm, an SM series cryptographic algorithm is used.

obs_bucket_name

No

String

Name of an OBS bucket. If an OBS bucket is specified, you do not need to set obs_encrypt and encrypt_type.

Table 4 resource_tags

Parameter

Mandatory

Type

Description

key

No

String

Tag key.

value

No

String

Tag value.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Job ID.

instance_id

String

Instance ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

  • Creating an SWR Enterprise Edition instance with a custom OBS bucket

    POST https://{endpoint}/v2/{project_id}/instances
    
    {
      "name" : "my-instance",
      "spec" : "swr.ee.professional",
      "vpc_id" : "vpc-12345678",
      "subnet_id" : "subnet-87654321",
      "project_id" : "project-123456",
      "charge_mode" : "postPaid",
      "enterprise_project_id" : "0",
      "resource_tags" : [ {
        "key" : "test",
        "value" : "test"
      } ],
      "obs_bucket_name" : "obs_bucket1"
    }
  • Creating an SWR Enterprise Edition instance, with an OBS bucket that is encrypted using the default algorithm

    POST https://{endpoint}/v2/{project_id}/instances
    
    {
      "name" : "my-instance",
      "description" : "My test instance",
      "spec" : "swr.ee.professional",
      "vpc_id" : "vpc-12345678",
      "subnet_id" : "subnet-87654321",
      "project_id" : "myproject-12345",
      "charge_mode" : "postPaid",
      "enterprise_project_id" : "0",
      "resource_tags" : [ {
        "key" : "test",
        "value" : "test"
      } ],
      "obs_encrypt" : true,
      "encrypt_type" : "",
      "obs_bucket_name" : "obs_bucket"
    }
  • Creating an SWR Enterprise Edition instance, with an OBS bucket that is encrypted using an SM series cryptographic algorithm

    POST https://{endpoint}/v2/{project_id}/instances
    
    {
      "name" : "my-instance",
      "description" : "My test instance",
      "spec" : "swr.ee.professional",
      "vpc_id" : "vpc-12345678",
      "subnet_id" : "subnet-87654321",
      "project_id" : "myproject-12345",
      "charge_mode" : "postPaid",
      "enterprise_project_id" : "0",
      "resource_tags" : [ {
        "key" : "test",
        "value" : "test"
      } ],
      "obs_encrypt" : true,
      "encrypt_type" : "gm",
      "obs_bucket_name" : "obs_bucket"
    }

Example Responses

Status code: 202

The instance is created successfully.

{
  "job_id" : "d8d691c4-27c4-4199-8c47-19dea40e5631",
  "instance_id" : "c6bc8d38-e14d-4767-a5c1-d55db63a2fb4"
}

SDK Sample Code

The SDK sample code is as follows.

Java

  • Creating an SWR Enterprise Edition instance with a custom OBS bucket

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.swr.v2.region.SwrRegion;
    import com.huaweicloud.sdk.swr.v2.*;
    import com.huaweicloud.sdk.swr.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class CreateInstanceSolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            SwrClient client = SwrClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(SwrRegion.valueOf("<YOUR REGION>"))
                    .build();
            CreateInstanceRequest request = new CreateInstanceRequest();
            CreateInstanceRequestBody body = new CreateInstanceRequestBody();
            List<CreateInstanceRequestBodyResourceTags> listbodyResourceTags = new ArrayList<>();
            listbodyResourceTags.add(
                new CreateInstanceRequestBodyResourceTags()
                    .withKey("test")
                    .withValue("test")
            );
            body.withObsBucketName("obs_bucket1");
            body.withResourceTags(listbodyResourceTags);
            body.withEnterpriseProjectId("0");
            body.withChargeMode(CreateInstanceRequestBody.ChargeModeEnum.fromValue("postPaid"));
            body.withProjectId("project-123456");
            body.withSubnetId("subnet-87654321");
            body.withVpcId("vpc-12345678");
            body.withSpec(CreateInstanceRequestBody.SpecEnum.fromValue("swr.ee.professional"));
            body.withName("my-instance");
            request.withBody(body);
            try {
                CreateInstanceResponse response = client.createInstance(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    
  • Creating an SWR Enterprise Edition instance, with an OBS bucket that is encrypted using the default algorithm

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.swr.v2.region.SwrRegion;
    import com.huaweicloud.sdk.swr.v2.*;
    import com.huaweicloud.sdk.swr.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class CreateInstanceSolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            SwrClient client = SwrClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(SwrRegion.valueOf("<YOUR REGION>"))
                    .build();
            CreateInstanceRequest request = new CreateInstanceRequest();
            CreateInstanceRequestBody body = new CreateInstanceRequestBody();
            List<CreateInstanceRequestBodyResourceTags> listbodyResourceTags = new ArrayList<>();
            listbodyResourceTags.add(
                new CreateInstanceRequestBodyResourceTags()
                    .withKey("test")
                    .withValue("test")
            );
            body.withObsBucketName("obs_bucket");
            body.withEncryptType(CreateInstanceRequestBody.EncryptTypeEnum.fromValue(""));
            body.withObsEncrypt(true);
            body.withResourceTags(listbodyResourceTags);
            body.withEnterpriseProjectId("0");
            body.withChargeMode(CreateInstanceRequestBody.ChargeModeEnum.fromValue("postPaid"));
            body.withProjectId("myproject-12345");
            body.withSubnetId("subnet-87654321");
            body.withVpcId("vpc-12345678");
            body.withSpec(CreateInstanceRequestBody.SpecEnum.fromValue("swr.ee.professional"));
            body.withDescription("My test instance");
            body.withName("my-instance");
            request.withBody(body);
            try {
                CreateInstanceResponse response = client.createInstance(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    
  • Creating an SWR Enterprise Edition instance, with an OBS bucket that is encrypted using an SM series cryptographic algorithm

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.swr.v2.region.SwrRegion;
    import com.huaweicloud.sdk.swr.v2.*;
    import com.huaweicloud.sdk.swr.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class CreateInstanceSolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            SwrClient client = SwrClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(SwrRegion.valueOf("<YOUR REGION>"))
                    .build();
            CreateInstanceRequest request = new CreateInstanceRequest();
            CreateInstanceRequestBody body = new CreateInstanceRequestBody();
            List<CreateInstanceRequestBodyResourceTags> listbodyResourceTags = new ArrayList<>();
            listbodyResourceTags.add(
                new CreateInstanceRequestBodyResourceTags()
                    .withKey("test")
                    .withValue("test")
            );
            body.withObsBucketName("obs_bucket");
            body.withEncryptType(CreateInstanceRequestBody.EncryptTypeEnum.fromValue("gm"));
            body.withObsEncrypt(true);
            body.withResourceTags(listbodyResourceTags);
            body.withEnterpriseProjectId("0");
            body.withChargeMode(CreateInstanceRequestBody.ChargeModeEnum.fromValue("postPaid"));
            body.withProjectId("myproject-12345");
            body.withSubnetId("subnet-87654321");
            body.withVpcId("vpc-12345678");
            body.withSpec(CreateInstanceRequestBody.SpecEnum.fromValue("swr.ee.professional"));
            body.withDescription("My test instance");
            body.withName("my-instance");
            request.withBody(body);
            try {
                CreateInstanceResponse response = client.createInstance(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    

Python

  • Creating an SWR Enterprise Edition instance with a custom OBS bucket

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkswr.v2.region.swr_region import SwrRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkswr.v2 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = SwrClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(SwrRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = CreateInstanceRequest()
            listResourceTagsbody = [
                CreateInstanceRequestBodyResourceTags(
                    key="test",
                    value="test"
                )
            ]
            request.body = CreateInstanceRequestBody(
                obs_bucket_name="obs_bucket1",
                resource_tags=listResourceTagsbody,
                enterprise_project_id="0",
                charge_mode="postPaid",
                project_id="project-123456",
                subnet_id="subnet-87654321",
                vpc_id="vpc-12345678",
                spec="swr.ee.professional",
                name="my-instance"
            )
            response = client.create_instance(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Creating an SWR Enterprise Edition instance, with an OBS bucket that is encrypted using the default algorithm

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkswr.v2.region.swr_region import SwrRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkswr.v2 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = SwrClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(SwrRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = CreateInstanceRequest()
            listResourceTagsbody = [
                CreateInstanceRequestBodyResourceTags(
                    key="test",
                    value="test"
                )
            ]
            request.body = CreateInstanceRequestBody(
                obs_bucket_name="obs_bucket",
                encrypt_type="",
                obs_encrypt=True,
                resource_tags=listResourceTagsbody,
                enterprise_project_id="0",
                charge_mode="postPaid",
                project_id="myproject-12345",
                subnet_id="subnet-87654321",
                vpc_id="vpc-12345678",
                spec="swr.ee.professional",
                description="My test instance",
                name="my-instance"
            )
            response = client.create_instance(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Creating an SWR Enterprise Edition instance, with an OBS bucket that is encrypted using an SM series cryptographic algorithm

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkswr.v2.region.swr_region import SwrRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkswr.v2 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = SwrClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(SwrRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = CreateInstanceRequest()
            listResourceTagsbody = [
                CreateInstanceRequestBodyResourceTags(
                    key="test",
                    value="test"
                )
            ]
            request.body = CreateInstanceRequestBody(
                obs_bucket_name="obs_bucket",
                encrypt_type="gm",
                obs_encrypt=True,
                resource_tags=listResourceTagsbody,
                enterprise_project_id="0",
                charge_mode="postPaid",
                project_id="myproject-12345",
                subnet_id="subnet-87654321",
                vpc_id="vpc-12345678",
                spec="swr.ee.professional",
                description="My test instance",
                name="my-instance"
            )
            response = client.create_instance(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    

Go

  • Creating an SWR Enterprise Edition instance with a custom OBS bucket

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/region"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := swr.NewSwrClient(
            swr.SwrClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.CreateInstanceRequest{}
    	keyResourceTags:= "test"
    	valueResourceTags:= "test"
    	var listResourceTagsbody = []model.CreateInstanceRequestBodyResourceTags{
            {
                Key: &keyResourceTags,
                Value: &valueResourceTags,
            },
        }
    	obsBucketNameCreateInstanceRequestBody:= "obs_bucket1"
    	request.Body = &model.CreateInstanceRequestBody{
    		ObsBucketName: &obsBucketNameCreateInstanceRequestBody,
    		ResourceTags: &listResourceTagsbody,
    		EnterpriseProjectId: "0",
    		ChargeMode: model.GetCreateInstanceRequestBodyChargeModeEnum().POST_PAID,
    		ProjectId: "project-123456",
    		SubnetId: "subnet-87654321",
    		VpcId: "vpc-12345678",
    		Spec: model.GetCreateInstanceRequestBodySpecEnum().SWR_EE_PROFESSIONAL,
    		Name: "my-instance",
    	}
    	response, err := client.CreateInstance(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • Creating an SWR Enterprise Edition instance, with an OBS bucket that is encrypted using the default algorithm

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/region"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := swr.NewSwrClient(
            swr.SwrClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.CreateInstanceRequest{}
    	keyResourceTags:= "test"
    	valueResourceTags:= "test"
    	var listResourceTagsbody = []model.CreateInstanceRequestBodyResourceTags{
            {
                Key: &keyResourceTags,
                Value: &valueResourceTags,
            },
        }
    	obsBucketNameCreateInstanceRequestBody:= "obs_bucket"
    	encryptTypeCreateInstanceRequestBody:= model.GetCreateInstanceRequestBodyEncryptTypeEnum().EMPTY
    	obsEncryptCreateInstanceRequestBody:= true
    	descriptionCreateInstanceRequestBody:= "My test instance"
    	request.Body = &model.CreateInstanceRequestBody{
    		ObsBucketName: &obsBucketNameCreateInstanceRequestBody,
    		EncryptType: &encryptTypeCreateInstanceRequestBody,
    		ObsEncrypt: &obsEncryptCreateInstanceRequestBody,
    		ResourceTags: &listResourceTagsbody,
    		EnterpriseProjectId: "0",
    		ChargeMode: model.GetCreateInstanceRequestBodyChargeModeEnum().POST_PAID,
    		ProjectId: "myproject-12345",
    		SubnetId: "subnet-87654321",
    		VpcId: "vpc-12345678",
    		Spec: model.GetCreateInstanceRequestBodySpecEnum().SWR_EE_PROFESSIONAL,
    		Description: &descriptionCreateInstanceRequestBody,
    		Name: "my-instance",
    	}
    	response, err := client.CreateInstance(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • Creating an SWR Enterprise Edition instance, with an OBS bucket that is encrypted using an SM series cryptographic algorithm

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/region"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := swr.NewSwrClient(
            swr.SwrClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.CreateInstanceRequest{}
    	keyResourceTags:= "test"
    	valueResourceTags:= "test"
    	var listResourceTagsbody = []model.CreateInstanceRequestBodyResourceTags{
            {
                Key: &keyResourceTags,
                Value: &valueResourceTags,
            },
        }
    	obsBucketNameCreateInstanceRequestBody:= "obs_bucket"
    	encryptTypeCreateInstanceRequestBody:= model.GetCreateInstanceRequestBodyEncryptTypeEnum().GM
    	obsEncryptCreateInstanceRequestBody:= true
    	descriptionCreateInstanceRequestBody:= "My test instance"
    	request.Body = &model.CreateInstanceRequestBody{
    		ObsBucketName: &obsBucketNameCreateInstanceRequestBody,
    		EncryptType: &encryptTypeCreateInstanceRequestBody,
    		ObsEncrypt: &obsEncryptCreateInstanceRequestBody,
    		ResourceTags: &listResourceTagsbody,
    		EnterpriseProjectId: "0",
    		ChargeMode: model.GetCreateInstanceRequestBodyChargeModeEnum().POST_PAID,
    		ProjectId: "myproject-12345",
    		SubnetId: "subnet-87654321",
    		VpcId: "vpc-12345678",
    		Spec: model.GetCreateInstanceRequestBodySpecEnum().SWR_EE_PROFESSIONAL,
    		Description: &descriptionCreateInstanceRequestBody,
    		Name: "my-instance",
    	}
    	response, err := client.CreateInstance(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

202

The instance is created successfully.

400

Request error.

401

Authentication failed.

403

Access denied.

404

Resource not found.

500

Internal error.

Error Codes

See Error Codes.