全部產品
Search
文件中心

Object Storage Service:調用GetCnameToken介面擷取已建立的CnameToken

更新時間:Sep 11, 2026

調用GetCnameToken介面擷取已建立的CnameToken。可通過wildcard參數指定擷取精確CNAME或泛網域名稱CNAME對應的Token。

注意事項

  • 對於Agentic Bucket,wildcard參數必選:wildcard=true為泛網域名稱CNAME擷取Token,wildcard=false為精確CNAME擷取Token,不允許預設或為空白。普通Bucket該參數可選,預設為精確CNAME(false)。

  • 查詢泛網域名稱CNAME的Token時,cname需傳入泛網域名稱基礎域(不含*.首碼),例如example.com。

請求文法

GET /?cname&comp=token&cname=example.com&wildcard=true HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Content-Type: application/xml
Content-Length: 186
Date: GMT Date
Authorization: SignatureValue

要求標頭

此介面僅包含公用要求標頭。更多資訊,請參見公用HTTP頭定義。

請求參數

名稱

類型

是否必選

樣本值

描述

cname

字串

是

example.com

目標網域名稱。精確CNAME傳入完整網域名稱,例如console.example.com;泛網域名稱CNAME傳入泛網域名稱基礎域(不含*.首碼),例如example.com。

wildcard

字串

普通Bucket:否

Agentic Bucket:是

true

是否擷取泛網域名稱CNAME的Token。取值如下:

  • true:擷取泛網域名稱CNAME的Token。

  • false:擷取精確CNAME的Token。

在Agentic Bucket上,該參數必選,必須顯式傳true或false,不允許預設或為空白。普通Bucket該參數可選,預設為false。

回應標頭

此介面僅涉及公用回應標頭。更多資訊,請參見公用HTTP頭定義。

響應元素

名稱

類型

樣本值

描述

CnameToken

容器

不涉及

CnameToken的容器。

父節點:無

子節點:Bucket、Cname、Token和ExpireTime

Bucket

字串

examplebucket

綁定Cname的Bucket名稱。

父節點:CnameToken

子節點:無

Cname

字串

example.com

綁定的Cname名稱。

父節點:CnameToken

子節點:無

Token

字串

be1d49d863dea9ffeff3df7d6455****

OSS返回的CnameToken。

父節點:CnameToken

子節點:無

ExpireTime

字串

Wed, 23 Feb 2022 21:16:37 GMT

CnameToken的有效時間。

父節點:CnameToken

子節點:無

樣本

  • 請求樣本

    • 查詢普通Bucket精確CNAME的CnameToken

      GET /?cname&comp=token&cname=example.com HTTP/1.1
      Host: oss-example.oss-cn-hangzhou.aliyuncs.com
      Content-Type: application/xml
      Content-Length: 186
      Date: Thu, 17 Apr 2025 15:39:12 GMT
      Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=content-length,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
    • 查詢Agentic Bucket泛網域名稱CNAME的CnameToken

      GET /?cname&comp=token&cname=example.com&wildcard=true HTTP/1.1
      Host: myab-$uid-$region-ab-apsr.oss-cn-hangzhou.aliyuncs.com
      Content-Type: application/xml
      Content-Length: 186
      Date: Thu, 17 Apr 2025 15:39:12 GMT
      Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=content-length,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
  • 返回樣本

    • CnameToken查詢成功

      HTTP/1.1 200 OK
      x-oss-request-id: 5C1B138A109F4E405B2D
      Date: Mon, 26 Jul 2021 13:08:38 GMT
      Content-Length: 118
      Content-Type: application/xml
      Connection: keep-alive
      Server: AliyunOSS
      <?xml version="1.0" encoding="UTF-8"?>
      <CnameToken>
        <Bucket>myab-$uid-$region-ab-apsr</Bucket>
        <Cname>example.com</Cname>
        <Token>be1d49d863dea9ffeff3df7d6455****</Token>
        <ExpireTime>Fri, 01 Aug 2026 03:00:00 GMT</ExpireTime>
      </CnameToken>
    • CnameToken未建立或已到期

      HTTP/1.1 404 Not Found
      x-oss-request-id: 5C1B138A109F4E405B2D
      Date: Mon, 26 Jul 2021 13:08:38 GMT
      Content-Length: 118
      Content-Type: application/xml
      Connection: keep-alive
      Server: AliyunOSS
      <?xml version="1.0" encoding="UTF-8"?>
      <Error>
        <Code>NoSuchCnameToken</Code>
        <Message>The specified cname token does not exist.</Message>
        <RequestId>6215FE05DA0E27393F005F0E</RequestId>
        <HostId>myab-$uid-$region-ab-apsr.oss-cn-hangzhou.aliyuncs.com</HostId>
        <Bucket>myab-$uid-$region-ab-apsr</Bucket>
        <Cname>example.com</Cname>
      </Error>

SDK

本介面對應的各語言SDK如下:

命令列工具ossutil

GetCnameToken介面所對應的ossutil命令,請參見get-cname-token。

錯誤碼

錯誤碼

HTTP狀態代碼

描述

InvalidArgument

400

返回此錯誤的可能原因如下:

  • 參數列表中未提供要查詢的Cname或Cname格式錯誤。

  • Domain傳入了非法字元,例如泛網域名稱字面量*.example.com。

  • Agentic Bucket上未傳wildcard參數,或wildcard參數存在但取值非法。

NoSuchCnameToken

404

該CNAME未建立過Token或Token已到期。

MethodNotAllowed

405

目標Bucket類型未開通CNAME能力。