Updated on 2025-08-19 GMT+08:00

Creating a Shared Cache Group

Function

This API is used to configure a shared cache group with a primary domain name to share its cache with other domain names. This improves the cache hit ratio.

  • A domain name can be added to a shared cache group only when Query Parameters is set to Ignore all or Retain all in its cache rules.

  • An account can have up to 500 shared cache groups.

  • A single tenant can call this API five times per second.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/cdn/configuration/share-cache-groups

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

group_name

No

String

Definition

Shared cache group name.

Constraints

N/A

Range

  • Enter 1 to 128 characters.

  • The following special characters are not supported: %&=?$"<>

Default Value

N/A

primary_domain

No

String

Definition

Primary domain name.

Constraints

Only one primary domain name is allowed.

Range

N/A

Default Value

N/A

share_cache_records

No

Array of ShareCacheGroupsRecord objects

Definition

Associated domain names.

Constraints

  • The primary domain name must be transferred.

  • Up to 50 associated domain names are allowed.

Table 2 ShareCacheGroupsRecord

Parameter

Mandatory

Type

Description

domain_name

No

String

Definition

Associated domain name.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 204

Request succeeded.

None

Example Requests

POST https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/share-cache-groups

{
  "group_name" : "example",
  "primary_domain" : "www.example.com",
  "share_cache_records" : [ {
    "domain_name" : "www.example.com"
  }, {
    "domain_name" : "www.example.cn.com"
  } ]
}

Example Responses

None

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
51
52
53
54
55
56
57
58
59
60
61
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.cdn.v2.region.CdnRegion;
import com.huaweicloud.sdk.cdn.v2.*;
import com.huaweicloud.sdk.cdn.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateShareCacheGroupsSolution {

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

        CdnClient client = CdnClient.newBuilder()
                .withCredential(auth)
                .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateShareCacheGroupsRequest request = new CreateShareCacheGroupsRequest();
        CreateShareCacheGroupsRequstBody body = new CreateShareCacheGroupsRequstBody();
        List<ShareCacheGroupsRecord> listbodyShareCacheRecords = new ArrayList<>();
        listbodyShareCacheRecords.add(
            new ShareCacheGroupsRecord()
                .withDomainName("www.example.com")
        );
        listbodyShareCacheRecords.add(
            new ShareCacheGroupsRecord()
                .withDomainName("www.example.cn.com")
        );
        body.withShareCacheRecords(listbodyShareCacheRecords);
        body.withPrimaryDomain("www.example.com");
        body.withGroupName("example");
        request.withBody(body);
        try {
            CreateShareCacheGroupsResponse response = client.createShareCacheGroups(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
35
36
37
38
39
40
41
42
43
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcdn.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"]

    credentials = GlobalCredentials(ak, sk)

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

    try:
        request = CreateShareCacheGroupsRequest()
        listShareCacheRecordsbody = [
            ShareCacheGroupsRecord(
                domain_name="www.example.com"
            ),
            ShareCacheGroupsRecord(
                domain_name="www.example.cn.com"
            )
        ]
        request.body = CreateShareCacheGroupsRequstBody(
            share_cache_records=listShareCacheRecordsbody,
            primary_domain="www.example.com",
            group_name="example"
        )
        response = client.create_share_cache_groups(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
45
46
47
48
49
50
51
52
package main

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

    client := cdn.NewCdnClient(
        cdn.CdnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateShareCacheGroupsRequest{}
	domainNameShareCacheRecords:= "www.example.com"
	domainNameShareCacheRecords1:= "www.example.cn.com"
	var listShareCacheRecordsbody = []model.ShareCacheGroupsRecord{
        {
            DomainName: &domainNameShareCacheRecords,
        },
        {
            DomainName: &domainNameShareCacheRecords1,
        },
    }
	primaryDomainCreateShareCacheGroupsRequstBody:= "www.example.com"
	groupNameCreateShareCacheGroupsRequstBody:= "example"
	request.Body = &model.CreateShareCacheGroupsRequstBody{
		ShareCacheRecords: &listShareCacheRecordsbody,
		PrimaryDomain: &primaryDomainCreateShareCacheGroupsRequstBody,
		GroupName: &groupNameCreateShareCacheGroupsRequstBody,
	}
	response, err := client.CreateShareCacheGroups(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

204

Request succeeded.

Error Codes

See Error Codes.