DeleteCname は、バケットからカスタムドメイン名 (CNAME) のマッピングを解除します。この操作はべき等です。指定された CNAME がバケットにマッピングされていない場合でも、エラーなしで HTTP 200 を返します。Agentic Bucket の場合、ワイルドカードパラメーターを使用して、完全一致の CNAME またはワイルドカード CNAME のどちらのマッピングを解除するかを明示的に指定する必要があります。
使用上の注意
エージェントバケットで DeleteCname API を呼び出す場合、
wildcardパラメーターが必須です。wildcard=trueはワイルドカード CNAME のマッピングを解除し、wildcard=falseは完全一致 CNAME のマッピングを解除します。標準バケットから完全一致 CNAME のマッピングを解除するには、既存の OSS CNAME 操作とまったく同じ方法でこの API を呼び出します。新しいパラメーターは不要です。
リクエスト構文
POST /?cname&comp=delete&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>wildcard パラメーターは、マッピング解除する CNAME のタイプを区別します。エージェントバケットの場合、このパラメーターは必須です。true または false を明示的に設定してください。標準バケットの場合、このパラメーターを省略すると、値はデフォルトで false になります。
リクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「Common HTTP headers」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
wildcard | String | 標準バケット:いいえ エージェントバケット:はい | true | ワイルドカード CNAME のマッピングを解除するかどうかを指定します。有効な値:
エージェントバケットの場合、このパラメーターは必須です。true または false を明示的に設定してください。標準バケットの場合、このパラメーターを省略すると、値はデフォルトで false になります。 |
wildcard パラメーターは、バケットタイプによって異なります:
バケットタイプ | パラメーター省略 | wildcard=false | wildcard=true |
標準バケット | 完全一致 CNAME のマッピングを解除します。 | 完全一致 CNAME のマッピングを解除します。 | — |
エージェントバケット | 許可されていません | エージェントバケットから完全一致 CNAME のマッピングを解除します。 | ワイルドカード CNAME のマッピングを解除します。 |
エージェントバケットの場合、同じベースドメイン名に対して、完全一致 CNAME とワイルドカード CNAME を同時にマッピングできます。マッピング解除する CNAME を特定するには、wildcard パラメーターを明示的に指定してください。
リクエスト要素
要素 | タイプ | 必須 | 例 | 説明 |
BucketCnameConfiguration | コンテナー | はい | N/A | CNAME 設定を格納するコンテナーです。 親ノード:なし 子ノード:Cname |
Cname | コンテナー | はい | N/A | CNAME 情報を格納するコンテナーです。 親ノード:BucketCnameConfiguration 子ノード:Domain |
Domain | String | はい | example.com | カスタムドメイン名です。完全一致 CNAME のマッピングを解除するには、この要素を console.example.com のような完全なドメイン名に設定します。ワイルドカード CNAME のマッピングを解除するには、この要素をプレフィックス 親ノード:Cname 子ノード:なし |
レスポンスヘッダー
この操作は、共通のレスポンスヘッダーのみを返します。詳細については、「Common HTTP headers」をご参照ください。
例
リクエストの例
標準バケットから完全一致 CNAME のマッピングを解除する
POST /?cname&comp=delete 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>console.example.com</Domain> </Cname> </BucketCnameConfiguration>エージェントバケットからワイルドカード CNAME のマッピングを解除する
POST /?cname&comp=delete&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>エージェントバケットから完全一致 CNAME のマッピングを解除する
POST /?cname&comp=delete&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>
レスポンスの例
HTTP/1.1 200 OK x-oss-request-id: 5C1B138A109F4E405B2D Date: Mon, 26 Jul 2021 13:08:38 GMT Content-Length: 0 Connection: keep-alive Server: AliyunOSS
OSS SDK
次の OSS SDK が DeleteCname API をサポートしています:
ossutil
DeleteCname 操作に対応する ossutil コマンドについては、「delete-cname」をご参照ください。
エラーコード
エラーコード | HTTP ステータスコード | 説明 |
InvalidArgument | 400 | このエラーの原因として、次が考えられます:
|
MalformedXML | 400 | リクエストボディの形式が無効です。 |
AccessDenied | 403 | DeleteCname 操作を呼び出す権限がありません。現在のバケットにマッピングされている CNAMEs は、バケットの所有者、および |
MethodNotAllowed | 405 | 対象のバケットタイプでは CNAME 機能が有効になっていません。 |