DeleteRegistry--镜像仓库-火山引擎

文档中心

立即注册

导航

DeleteRegistry

最近更新时间：2024.11.28 11:20:00首次发布时间：2022.06.14 21:29:04

删除镜像仓库标准版实例。

接口说明

删除标准版实例时，费用相关说明如下：

请求参数中配置了 DeleteImmediately 且值为 true，则接口返回成功调用结果时，停止计费。
请求参数中未配置 DeleteImmediately 或值为 false，则接口返回成功调用结果时，实例进入待回收（{Stopped, [Released]}）状态，继续计费。待回收状态下，超过七天后回收实例，停止计费。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=DeleteRegistry&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时，除了以下请求参数外，还需传入公共请求参数。公共请求参数说明，请参见火山引擎公共参数文档。

参数	类型	是否必选	示例值	描述
Action	String	是	DeleteRegistry	接口名称。当前 API 的名称为 `DeleteRegistry`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Name	String	是	example	要删除的标准版实例名称。在镜像仓库控制台的实例列表页面，获取标准版实例名称。
DeleteImmediately	Boolean	否	false	是否立即删除标准版实例： false：实例进入`{Stopped, [Released]}`待回收状态，7 天后会自动彻底删除，7 天内可通过调用 StartRegistry 接口恢复至`{Running, []}`状态。 true：立即彻底删除实例，不可恢复。默认值 false*。

请求示例

POST https://open.volcengineapi.com?Action=DeleteRegistry&Version=2022-05-12
{
    "Name": "example"
}

返回参数

无

返回示例

{
    "ResponseMetadata" : {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "DeleteRegistry",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing",
    },
    "Result": {}
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.Status	The action has been denied due to wrong status %s.	当前访问入口状态下不允许执行指定操作，请等待状态转换后重试。