DeletePrefixList--私有网络-火山引擎

文档中心

立即注册

导航

DeletePrefixList

最近更新时间：2024.07.09 08:30:24首次发布时间：2023.09.05 08:11:45

调用 DeletePrefixList 接口，删除前缀列表。

调用说明

前缀列表未关联安全组或路由表。若已关联，请参考修改安全组规则和删除路由条目。
DeletePrefixList 为异步接口，即返回请求ID时，系统后台仍在删除。您可调用 DescribePrefixLists 查看网卡的状态，Deleting表示创建中，查看失败表示删除完成。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DeletePrefixList	要执行的操作，取值：DeletePrefixList。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
PrefixListId	String	是	pl-bp1fg655nh68xyz9****	要删除的前缀列表的ID。您可以调用 DescribePrefixLists 接口，查询前缀列表的ID。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	客户端Token，用于保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。仅支持ASCII字符，且不能超过64个字符。若不传入ClientToken，则此次API调用不进行幂等校验。
DryRun	Boolean	否	false	是否只预检此次请求。取值： true：发送检查请求，不会删除前缀列表。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除前缀列表。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。

请求示例

GET /?Action=DeletePrefixList&Version=2020-04-01&NetworkInterfaceId=eni-bp1fgnh68xyz9**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DeletePrefixList",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400	InvalidPrefixList.InUse	The specified prefix list is in use, and can't be deleted.	指定的前缀列表在使用中，无法删除。
400	InvalidPrefixList.InvalidStatus	The specified prefix list is not in the correct status for the request.	指定的前缀列表所处状态无法响应该请求。
400	MissingParameter	The request is missing a required parameter.	该请求缺少必要参数。
404	InvalidPrefixList.NotFound	The specified prefix list does not exist.	指定的前缀列表不存在。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。