Object Storage Service：調用CreateCnameToken介面建立網域名稱所有權驗證所需的CnameToken

注意事項

• CnameToken預設在建立完成後72小時內到期。如果在CnameToken到期時間內重複建立CnameToken，則返回已存在的CnameToken。

• 對於Agentic Bucket，wildcard參數必選：wildcard=true為泛網域名稱CNAME建立Token，wildcard=false為精確CNAME建立Token，不允許預設或為空白。

• 普通Bucket為精確CNAME建立Token的調用方式與既有OSS CNAME OpenAPI完全一致，無需引入任何新參數。

請求文法

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

<BucketCnameConfiguration>
  <Cname>
    <Domain>example.com</Domain>
  </Cname>
</BucketCnameConfiguration>

要求標頭

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

請求參數

各Bucket類型下wildcard參數的取值規則如下：

請求元素

等冪語義

針對該CNAME是否已綁定到當前Bucket，CreateCnameToken的等冪語義因Bucket類型而異：

• 普通Bucket：該CNAME已被當前Bucket綁定（任一非刪除狀態）時，返回NoNeedCreateCnameToken，無需繼續建立Token。

• Agentic Bucket：僅當該基礎網域名稱已被當前AgenticBucket綁定同類型的CNAME時，才返回NoNeedCreateCnameToken。

響應元素

樣本

• 請求樣本

  • 為普通Bucket建立CnameToken

    POST /?cname&comp=token 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
    
    <BucketCnameConfiguration>
      <Cname>
        <Domain>example.com</Domain>
      </Cname>
    </BucketCnameConfiguration>

  • 為Agentic Bucket的泛網域名稱CNAME建立CnameToken

    POST /?cname&comp=token&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
    
    <BucketCnameConfiguration>
      <Cname>
        <Domain>example.com</Domain>
      </Cname>
    </BucketCnameConfiguration>

  • 為Agentic Bucket的精確CNAME建立CnameToken

    POST /?cname&comp=token&wildcard=false 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
    
    <BucketCnameConfiguration>
      <Cname>
        <Domain>console.example.com</Domain>
      </Cname>
    </BucketCnameConfiguration>

• 返回樣本

  • 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 400 Bad Request
    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>TooManyCnameToken</Code>
      <Message>You have attempted to create more cname token than allowed.</Message>
      <RequestId>6215FD21DA0E27393F004E9E</RequestId>
      <HostId>127.0.0.1</HostId>
      <Bucket>examplebucket</Bucket>
    </Error>

SDK

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

• Java

• Python V2

• Go V2

• Node.js

• PHP V2

命令列工具ossutil

CreateCnameToken介面所對應的ossutil命令，請參見create-cname-token。

錯誤碼