Object Storage Service:CreateCnameToken - ドメイン名の所有権を検証するための CNAME トークンの作成

使用上の注意

• デフォルトでは、CNAME トークンは作成後 72 時間で有効期限が切れます。 トークンがまだ有効である間にこの API を再度呼び出した場合、OSS は既存のトークンを返します。

• Agentic バケットの場合、wildcard パラメーターは必須であり、空にすることはできません。 wildcard=true はワイルドカード CNAME のトークンを作成し、 wildcard=false は完全一致 CNAME のトークンを作成します。

• 標準バケットの場合、完全一致 CNAME のトークン作成は、既存の OSS CNAME 操作とまったく同じように動作します。 新しいパラメーターは不要です。

リクエスト構文

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>

リクエストヘッダー

この API は、共通のリクエストヘッダーのみを使用します。 詳細については、「共通 HTTP ヘッダー」をご参照ください。

リクエストパラメーター

wildcard パラメーターは、バケットタイプごとに異なる値を取ります：

リクエスト要素

べき等性

CreateCnameToken のべき等性は、バケットタイプと、CNAME が現在のバケットにすでにマッピングされているかどうかによって異なります：

• 標準バケット：CNAME が削除済み以外の状態で現在のバケットにすでにマッピングされている場合、 OSS は NoNeedCreateCnameToken を返し、トークンを作成する必要はありません。

• Agentic バケット： OSS は、現在の Agentic バケットが、同じタイプの CNAME にベースドメイン名をすでにマッピングしている場合にのみ NoNeedCreateCnameToken を返します。

レスポンス要素

例

• リクエストの例

  • 標準バケットの CNAME トークンの作成

    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 バケットのワイルドカード CNAME の CNAME トークンの作成

    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 バケットの完全一致 CNAME の CNAME トークンの作成

    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>

• レスポンスの例

  • CNAME トークンが作成された場合

    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>Thu, 29 Jul 2021 14:00:00 GMT</ExpireTime>
    </CnameToken>

  • CNAME トークンの数が上限を超えた場合

    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>

OSS SDK

CreateCnameToken API をサポートする OSS SDK は次のとおりです：

• Java

• Python V2

• Go V2

• Node.js

• PHP V2

ossutil

CreateCnameToken API に対応する ossutil コマンドの詳細については、「create-cname-token」をご参照ください。

エラーコード