Updated on 2024-03-20 GMT+08:00

Querying Regions Supported for a Cloud Vendor

Function

This API is used to query regions supported for a cloud vendor.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/objectstorage/data-center

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

Minimum length: 1 character

Maximum length: 1,024 characters

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The IAM token authentication. Ensure that the project ID contained in the token matches the project ID in the request URI.

Minimum length: 1 character

Maximum length: 16,384 characters

Response

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[Array element]

Array of ShowRegionInfoResp objects

The queried region information.

Table 4 ShowRegionInfoResp field description

Parameter

Type

Description

service_name

String

The cloud vendor name.

Minimum length: 0 characters

Maximum length: 255 characters

region_list

Array of RegionInfo objects

The region list.

Array length: 0 to 1,024

Table 5 RegionInfo field description

Parameter

Type

Description

cloud_type

String

The cloud service name.

Minimum length: 1 character

Maximum length: 255 characters

value

String

The region name.

Minimum length: 1 character

Maximum length: 255 characters

description

String

The region description.

Minimum length: 0 characters

Maximum length: 1,024 characters

Example Request

None

Example Response

Status code: 200

The region list was returned.

[ {
  "service_name" : "AWS",
  "region_list" : [ {
    "cloud_type" : "AWS",
    "value" : "us-east-1",
    "description" : "US Standard (N. Virginia)"
  }, {
    "cloud_type" : "AWS",
    "value" : "us-west-1",
    "description" : "US West (N. California)"
  }, {
    "cloud_type" : "AWS",
    "value" : "us-west-2",
    "description" : "US West (Oregon)"
  }, {
    "cloud_type" : "AWS",
    "value" : "eu-west-1",
    "description" : "EU (Ireland)"
  }, {
    "cloud_type" : "AWS",
    "value" : "eu-central-1",
    "description" : "EU (Frankfurt)"
  }, {
    "cloud_type" : "AWS",
    "value" : "ap-northeast-1",
    "description" : "Asia Pacific (Tokyo)"
  }, {
    "cloud_type" : "AWS",
    "value" : "ap-northeast-2",
    "description" : "Asia Pacific (Seoul)"
  }, {
    "cloud_type" : "AWS",
    "value" : "ap-southeast-1",
    "description" : "Asia Pacific (Singapore)"
  }, {
    "cloud_type" : "AWS",
    "value" : "ap-southeast-2",
    "description" : "Asia Pacific (Sydney)"
  }, {
    "cloud_type" : "AWS",
    "value" : "ap-south-1",
    "description" : "Asia Pacific (Mumbai)"
  }, {
    "cloud_type" : "AWS",
    "value" : "sa-east-1",
    "description" : "South America (Sao Paulo)"
  }, {
    "cloud_type" : "AWS",
    "value" : "us-east-2",
    "description" : "US East (Ohio)"
  }, {
    "cloud_type" : "AWS",
    "value" : "eu-west-2",
    "description" : "EU (London)"
  }, {
    "cloud_type" : "AWS",
    "value" : "ca-central-1",
    "description" : "Canada (Central)"
  }, {
    "cloud_type" : "AWS",
    "value" : "ap-east-1",
    "description" : "Asia Pacific (Hong Kong)"
  } ]
} ]

SDK Sample Code

The sample code is as follows:

 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
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.oms.v2.region.OmsRegion;
import com.huaweicloud.sdk.oms.v2.*;
import com.huaweicloud.sdk.oms.v2.model.*;


public class ShowRegionInfoSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        OmsClient client = OmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(OmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowRegionInfoRequest request = new ShowRegionInfoRequest();
        try {
            ShowRegionInfoResponse response = client.showRegionInfo(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());
        }
    }
}
 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkoms.v2.region.oms_region import OmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkoms.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = OmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowRegionInfoRequest()
        response = client.show_region_info(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := oms.NewOmsClient(
        oms.OmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowRegionInfoRequest{}
	response, err := client.ShowRegionInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

Status Codes

Status Code

Description

200

The region list was returned.

Error Codes

For details, see Error Codes.