Help Center> Cloud Connect> API Reference> API> Cloud Connection Quotas> Querying Cloud Connection Resource Quotas
Updated on 2024-03-29 GMT+08:00

Querying Cloud Connection Resource Quotas

Function

This API is used to query cloud connection resource quotas.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{domain_id}/ccaas/quotas

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Minimum: 10

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page.

Value range: 1 to 1000

Minimum: 1

Maximum: 1000

Default: 1000

marker

No

String

Pagination query information. You can obtain the marker values from the response of the last API call. You can enter the marker value of the previous page or the next page. If you enter the marker value of the previous page, the previous page will be queried. If you enter the marker value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the limit value, cannot be modified.

Minimum: 1

Maximum: 4096

quota_type

Yes

String

Quota type.

  • cloud_connection: the number of cloud connections

  • cloud_connection_region: the number of regions where a cloud connection can be used

  • cloud_connection_route: the number of routes that can be added to a cloud connection

  • region_network_instance: the number of network instances that can be loaded to a cloud connection in a region

Minimum: 0

Maximum: 36

cloud_connection_id

No

String

Cloud connection ID. This parameter is mandatory when you query the value of each of the three parameters: cloud_connection_region, cloud_connection_route, and region_network_instance.

Minimum: 0

Maximum: 36

region_id

No

String

Region ID. This parameter is mandatory when you query the value of region_network_instance.

Minimum: 0

Maximum: 36

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Minimum: 0

Maximum: 2000000

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Resource ID.

Minimum: 32

Maximum: 36

quotas

Array of CloudConnectionQuota objects

Quota list.

Array Length: 0 - 2000

Table 5 CloudConnectionQuota

Parameter

Type

Description

domain_id

String

ID of the account that the instance belongs to.

cloud_connection_id

String

Resource ID.

region_id

String

Region ID.

quota_type

String

Quota type.

  • cloud_connection: the number of cloud connections

  • cloud_connection_region: the number of regions where a cloud connection can be used

  • cloud_connection_route: the number of routes that can be added to a cloud connection

  • region_network_instance: the number of network instances that can be loaded to a cloud connection in a region

quota_number

Integer

Total quotas.

Minimum: 0

Maximum: 102400

quota_used

Integer

Used quotas.

Minimum: 0

Maximum: 102400

Example Requests

Querying resource quotas

GET https://{cc_endpoint}/v3/{domain_id}/ccaas/quotas?quota_type=cloud_connection

Example Responses

Status code: 200

The Cloud Connect resource quotas have been queried.

{
  "request_id" : "XXX",
  "quotas" : [ {
    "domain_id" : "XXX",
    "quota_type" : "cloud_connection",
    "quota_number" : 6,
    "quota_used" : 3
  } ]
}

SDK Sample Code

The SDK 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
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.cc.v3.region.CcRegion;
import com.huaweicloud.sdk.cc.v3.*;
import com.huaweicloud.sdk.cc.v3.model.*;


public class ListCloudConnectionQuotasSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListCloudConnectionQuotasRequest request = new ListCloudConnectionQuotasRequest();
        request.withQuotaType(ListCloudConnectionQuotasRequest.QuotaTypeEnum.fromValue("<quota_type>"));
        request.withCloudConnectionId("<cloud_connection_id>");
        request.withRegionId("<region_id>");
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        try {
            ListCloudConnectionQuotasResponse response = client.listCloudConnectionQuotas(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
30
31
32
33
34
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v3.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.v3 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 = GlobalCredentials(ak, sk) \

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

    try:
        request = ListCloudConnectionQuotasRequest()
        request.quota_type = "<quota_type>"
        request.cloud_connection_id = "<cloud_connection_id>"
        request.region_id = "<region_id>"
        request.limit = <limit>
        request.marker = "<marker>"
        response = client.list_cloud_connection_quotas(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
36
37
38
39
40
41
42
43
44
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListCloudConnectionQuotasRequest{}
	request.QuotaType = model.GetListCloudConnectionQuotasRequestQuotaTypeEnum().<QUOTA_TYPE>
	cloudConnectionIdRequest:= "<cloud_connection_id>"
	request.CloudConnectionId = &cloudConnectionIdRequest
	regionIdRequest:= "<region_id>"
	request.RegionId = &regionIdRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ListCloudConnectionQuotas(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

200

The Cloud Connect resource quotas have been queried.

Error Codes

See Error Codes.