创建命名空间

最近更新时间:2024-08-28 02:25:42

我的收藏

1. 接口描述

接口请求域名: tcr.tencentcloudapi.com 。

用于在企业版中创建命名空间

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateNamespace。
Version String 公共参数,本接口取值:2019-09-24。
Region String 公共参数,详见产品支持的 地域列表
RegistryId String 实例ID
示例值:tcr-okmj78
NamespaceName String 命名空间的名称(长度2-30个字符,只能包含小写字母、数字及分隔符("."、"_"、"-"),且不能以分隔符开头、结尾或连续)
示例值:mytest
IsPublic Boolean 是否公开,true为公开,fale为私有
示例值:true
TagSpecification TagSpecification 云标签描述
IsAutoScan Boolean 自动扫描级别,true为自动,false为手动
示例值:true
IsPreventVUL Boolean 安全阻断级别,true为自动,false为手动
示例值:true
Severity String 阻断漏洞等级,目前仅支持low、medium、high
示例值:low
CVEWhitelistItems.N Array of CVEWhitelistItem 漏洞白名单列表

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建命名空间

在企业版中创建命名空间

输入示例

POST / HTTP/1.1
Host: tcr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNamespace
<公共请求参数>

{
    "NamespaceName": "mytest",
    "IsPublic": "true",
    "IsAutoScan": "true",
    "IsPreventVUL": "true",
    "Severity": "low",
    "RegistryId": "tcr-okmj78"
}

输出示例

{
    "Response": {
        "RequestId": "2ac430cd-f7de-482e-b98e-f78a48e785e8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.DependenceError 依赖服务异常。
FailedOperation.ErrorTcrInvalidMediaType Tcr实例请求无效的Hearder类型。
FailedOperation.ErrorTcrResourceConflict Tcr实例资源冲突。
FailedOperation.ErrorTcrUnauthorized 没有Tcr操作权限。
FailedOperation.OperationCancel 操作取消。
InternalError 内部错误。
InternalError.DbError 数据库错误。
InternalError.ErrorTcrInternal Tcr实例内部错误。
InternalError.ErrorTcrInvalidMediaType Tcr实例请求无效的Hearder类型。
InternalError.ErrorTcrResourceConflict Tcr实例资源冲突。
InternalError.ErrorTcrUnauthorized 没有Tcr操作权限。
InvalidParameter 参数错误。
InvalidParameter.ErrorTcrInvalidParameter 无效的TCR请求。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。