调用DeleteCname接口删除某个存储空间Bucket已绑定的Cname

更新时间:
复制 MD 格式

调用DeleteCname接口删除某个存储空间(Bucket)已绑定的Cname。该接口具有幂等性,若Bucket未绑定指定Cname,接口同样返回HTTP 200,不返回错误。对于Agentic Bucket,需通过wildcard参数显式指定删除精确CNAME或泛域名CNAME。

注意事项

  • Agentic Bucket上调用DeleteCname时,wildcard参数必选:wildcard=true用于删除泛域名CNAME,wildcard=false用于删除精确CNAME,不允许缺省或为空。

  • 普通Bucket删除精确CNAME的调用方式与既有OSS CNAME OpenAPI完全一致,无需引入任何新参数。

请求语法

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


  
    example.com
  
说明

wildcard参数用于区分删除的CNAME类别。对于Agentic Bucket,该参数必选,必须显式传truefalse,不允许缺省或为空。普通Bucket该参数可选,缺省为false(即精确CNAME)。

请求头

此接口仅包含公共请求头。更多信息,请参见公共HTTP头定义

请求参数

名称

类型

是否必选

示例值

描述

wildcard

字符串

普通Bucket:否

Agentic Bucket:是

true

是否删除泛域名CNAME。取值如下:

  • true:删除泛域名CNAME。

  • false:删除精确CNAME。

对于Agentic Bucket,该参数必选,必须显式传truefalse,不允许缺省或为空。普通Bucket该参数可选,缺省为false。

Bucket类型下wildcard参数的取值规则如下:

Bucket类型

参数缺省

wildcard=false

wildcard=true

普通Bucket

删除精确CNAME。

删除精确CNAME。

Agentic Bucket

不允许

删除Agentic Bucket上的精确CNAME。

删除泛域名CNAME。

说明

Agentic Bucket的同一基础域可能同时存在精确和泛域名两条绑定,因此必须显式指定wildcard参数以明确删除目标。

请求元素

名称

类型

是否必选

示例值

描述

BucketCnameConfiguration

容器

不涉及

Cname配置的容器。

父节点:无

子节点:Cname

Cname

容器

不涉及

Cname信息的容器。

父节点:BucketCnameConfiguration

子节点:Domain

Domain

字符串

example.com

自定义域名。删除精确CNAME时传入完整域名,例如console.example.com;删除泛域名CNAME时传入泛域名基础域(不含*.前缀),例如example.com。

父节点:Cname

子节点:无

响应头

此接口仅涉及公共响应头。更多信息,请参见公共HTTP头定义

示例

  • 请求示例

    • 为普通Bucket删除精确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
      
      
        
          example.com
        
      
    • Agentic Bucket删除泛域名CNAME

      POST /?cname&comp=delete&wildcard=true HTTP/1.1
      Host: my-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
      
      
        
          example.com
        
      
    • Agentic Bucket删除精确CNAME

      POST /?cname&comp=delete&wildcard=false HTTP/1.1
      Host: my-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
      
      
        
          console.example.com
        
      
  • 返回示例

    HTTP/1.1 204 No Content
    x-oss-request-id: 5C1B138A109F4E405B2D
    Date: Mon, 26 Jul 2021 13:08:38 GMT
    Connection: keep-alive
    Server: AliyunOSS

SDK

本接口对应的各语言SDK如下:

命令行工具ossutil

DeleteCname接口所对应的ossutil命令,请参见delete-cname

错误码

错误码

HTTP状态码

描述

InvalidArgument

400

返回此错误的可能原因如下:

  • Domain传入了非法字符,例如泛域名字面量*.example.com

MalformedXML

400

请求Body格式不合法。

AccessDenied

403

没有调用DeleteCname接口的权限。仅Bucket拥有者以及被授予oss:DeleteCname权限的用户可以删除当前Bucket下已绑定的Cname。

MethodNotAllowed

405

目标Bucket类型未开通CNAME能力。