Updated on 2025-11-18 GMT+08:00

Querying CDN Information of a Bucket

Function

This API is used to query the CDN information of a bucket.

Calling Method

For details, see Calling APIs.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    oms::checkCdnInfo

    Read

    -

    -

    -

    -

URI

POST /v2/{project_id}/objectstorage/buckets/cdn-info

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 in the token matches the project ID in the request URI.

Minimum length: 1 character

Maximum length: 16,384 characters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ak

Yes

String

The AK for accessing the source bucket. Enter a maximum of 100 characters. This parameter is mandatory when task_type is not url_list.

Minimum length: 0 characters

Maximum length: 100 characters

sk

Yes

String

The SK for accessing the source bucket. Enter a maximum of 100 characters. This parameter is mandatory when task_type is not url_list.

Minimum length: 0 characters

Maximum length: 100 characters

cloud_type

Yes

String

The cloud service provider.

AWS

Aliyun: Alibaba Cloud

Qiniu: Qiniu Cloud

QingCloud

Tencent: Tencent Cloud

Baidu: Baidu Cloud

KingsoftCloud

Azure: Microsoft Azure

UCloud

HuaweiCloud: Huawei Cloud

URLSource: URL data sources

HEC: HEC

Minimum length: 0 characters

Maximum length: 100 characters

region

Yes

String

Region.

Minimum length: 0 characters

Maximum length: 100 characters

app_id

No

String

This parameter is returned when cloud_type is Tencent.

Minimum length: 0 characters

Maximum length: 255 characters

bucket

Yes

String

The bucket name.

Minimum length: 0 characters

Maximum length: 100 characters

prefix

No

PrefixKeyInfo object

The prefix.

source_cdn

Yes

SourceCdnReq object

Whether migration from CDN is enabled. If this field is included, migration from CDN is supported. Otherwise, it is not supported. If migration from CDN is enabled, the source objects to be migrated are obtained from the specified CDN domain name during migration.

Table 4 PrefixKeyInfo

Parameter

Mandatory

Type

Description

keys

Yes

Array of strings

Keys.

Minimum length: 0 characters

Maximum length: 2,048 characters

Array length: 0 to 100

Table 5 SourceCdnReq

Parameter

Mandatory

Type

Description

authentication_key

No

String

The CDN authentication key. This parameter is mandatory if CDN authentication is required.

If no authorization is required, do not set this parameter.

Qiniu: You do not need to set this parameter.

Aliyun: Set this parameter based on the value of authentication_type.

KingsoftCloud: You do not need to set this parameter.

Minimum length: 0 characters

Maximum length: 255 characters

authentication_type

Yes

String

The authentication type.

NONE: public access without authentication type

QINIU_PRIVATE_AUTHENTICATION: Qiniu private URL signature

ALIYUN_OSS_A: Alibaba Cloud URL signature, simple and universal

ALIYUN_OSS_B: Alibaba Cloud header signature, used for API calling

ALIYUN_OSS_C: Alibaba Cloud STS temporary security token, the most secure

KSYUN_PRIVATE_AUTHENTICATION: Kingsoft Cloud private URL signature

AZURE_SAS_TOKEN: Microsoft Azure shared access signature, flexible and secure

TENCENT_COS_A: Tencent Cloud multi-signature scenarios (not recommended)

TENCENT_COS_B: Tencent Cloud single-signature scenarios, the most secure

TENCENT_COS_C: Tencent Cloud header signature, used for API calling

TENCENT_COS_D: Tencent Cloud header signature, used for API calling

Default value: NONE

Enumerated values:

  • NONE

  • QINIU_PRIVATE_AUTHENTICATION

  • ALIYUN_OSS_A

  • ALIYUN_OSS_B

  • ALIYUN_OSS_C

  • KSYUN_PRIVATE_AUTHENTICATION

  • AZURE_SAS_TOKEN

  • TENCENT_COS_A

  • TENCENT_COS_B

  • TENCENT_COS_C

  • TENCENT_COS_D

domain

Yes

String

The domain name used to obtain objects to be migrated.

Minimum length: 0 characters

Maximum length: 1,024 characters

protocol

Yes

String

The protocol type. HTTP and HTTPS are supported.

Enumerated values:

  • http

  • https

Response

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

is_same_cloud_type

Boolean

Whether the CDN is provided by the source cloud vendor.

is_download_available

Boolean

Whether source data can be downloaded from the CDN.

checked_keys

Array of CheckedKey objects

The array of checked objects returned.

Array length: 0 to 1,000

Table 7 CheckedKey

Parameter

Type

Description

key

String

Key.

Minimum length: 0 characters

Maximum length: 2,048 characters

is_etag_matching

Boolean

Whether the etag is matched.

is_object_existing

Boolean

Whether the object is found.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Example Request

This example queries the CDN information of the xxx bucket using the xcsad key in ALIYUN_OSS_B authentication type.

POST https://{endpoint}/v2/{project_id}/objectstorage/buckets/cdn-info

{
  "ak" : "xxx",
  "sk" : "xxx",
  "cloud_type" : "Aliyun",
  "region" : "cn-hangzhou",
  "bucket" : "xxx",
  "source_cdn" : {
    "protocol" : "https",
    "domain" : "xxx",
    "authentication_type" : "ALIYUN_OSS_B",
    "authentication_key" : "xcsad"
  }
}

Example Response

Status code: 200

CDN information returned

{
  "is_same_cloud_type" : false,
  "is_download_available" : false,
  "checked_keys" : [ {
    "key" : "xxx",
    "is_etag_matching" : false,
    "is_object_existing" : false
  }, {
    "key" : "yyy",
    "is_etag_matching" : false,
    "is_object_existing" : false
  }, {
    "key" : "ccc",
    "is_etag_matching" : false,
    "is_object_existing" : false
  }, {
    "key" : "bbb",
    "is_etag_matching" : false,
    "is_object_existing" : false
  }, {
    "key" : "nnnn",
    "is_etag_matching" : false,
    "is_object_existing" : false
  } ]
}

SDK Sample Code

The following shows the sample SDK code.

This example queries the CDN information of the xxx bucket using the xcsad key in ALIYUN_OSS_B authentication type.

 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
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 ShowCdnInfoSolution {

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

        OmsClient client = OmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(OmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowCdnInfoRequest request = new ShowCdnInfoRequest();
        ShowCdnInfoReq body = new ShowCdnInfoReq();
        SourceCdnReq sourceCdnbody = new SourceCdnReq();
        sourceCdnbody.withAuthenticationKey("xcsad")
            .withAuthenticationType(SourceCdnReq.AuthenticationTypeEnum.fromValue("ALIYUN_OSS_B"))
            .withDomain("xxx")
            .withProtocol(SourceCdnReq.ProtocolEnum.fromValue("https"));
        body.withSourceCdn(sourceCdnbody);
        body.withBucket("xxx");
        body.withRegion("cn-hangzhou");
        body.withCloudType("Aliyun");
        body.withSk("xxx");
        body.withAk("xxx");
        request.withBody(body);
        try {
            ShowCdnInfoResponse response = client.showCdnInfo(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());
        }
    }
}

This example queries the CDN information of the xxx bucket using the xcsad key in ALIYUN_OSS_B authentication type.

 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
# coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ShowCdnInfoRequest()
        sourceCdnbody = SourceCdnReq(
            authentication_key="xcsad",
            authentication_type="ALIYUN_OSS_B",
            domain="xxx",
            protocol="https"
        )
        request.body = ShowCdnInfoReq(
            source_cdn=sourceCdnbody,
            bucket="xxx",
            region="cn-hangzhou",
            cloud_type="Aliyun",
            sk="xxx",
            ak="xxx"
        )
        response = client.show_cdn_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)

This example queries the CDN information of the xxx bucket using the xcsad key in ALIYUN_OSS_B authentication type.

 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/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")
    projectId := "{project_id}"

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

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

    request := &model.ShowCdnInfoRequest{}
	authenticationKeySourceCdn:= "xcsad"
	sourceCdnbody := &model.SourceCdnReq{
		AuthenticationKey: &authenticationKeySourceCdn,
		AuthenticationType: model.GetSourceCdnReqAuthenticationTypeEnum().ALIYUN_OSS_B,
		Domain: "xxx",
		Protocol: model.GetSourceCdnReqProtocolEnum().HTTPS,
	}
	request.Body = &model.ShowCdnInfoReq{
		SourceCdn: sourceCdnbody,
		Bucket: "xxx",
		Region: "cn-hangzhou",
		CloudType: "Aliyun",
		Sk: "xxx",
		Ak: "xxx",
	}
	response, err := client.ShowCdnInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

Status Codes

Status Code

Description

200

CDN information returned

400

Standard error response

Error Codes

For details, see Error Codes.