物联网边缘计算平台获取命名空间-配置管理相关接口-API 中心-腾讯云

1. 接口描述

此接口处于预下线状态。

预计下线时间：2025-02-03 15:33:36

接口请求域名： iecp.tencentcloudapi.com 。

产品下线

获取命名空间

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeNamespace。
Version	是	String	公共参数，本接口取值：2021-09-14。
Region	否	String	公共参数，本接口不需要传递此参数。
EdgeUnitID	是	Integer	单元ID 示例值：1
Namespace	是	String	命名空间名示例值：default

3. 输出参数

参数名称	类型	描述
Namespace	String	命名空间名注意：此字段可能返回 null，表示取不到有效值。示例值：default
Status	String	状态 (Active\|Terminating) 注意：此字段可能返回 null，表示取不到有效值。示例值：Active
Description	String	描述信息注意：此字段可能返回 null，表示取不到有效值。示例值：descript
CreateTime	String	创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：2021-01-01 00:00:00
Protected	Boolean	是否保护-不允许删除注意：此字段可能返回 null，表示取不到有效值。示例值：true
Yaml	String	Yaml文件格式注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeNamespace

输入示例

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

{
    "EdgeUnitID": 1,
    "Namespace": "default"
}

输出示例

{
    "Response": {
        "RequestId": "72d540a0-ed11-4370-b977-96c6c224a1d8",
        "Status": "Active",
        "Description": "",
        "Namespace": "test",
        "CreateTime": "2021-01-01 00:00:00",
        "Protected": false,
        "Yaml": ""
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.DBError	数据库异常。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.DuplicateName	名字冲突。
ResourceInsufficient	资源不足。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
ResourcesSoldOut	资源售罄。
UnauthorizedOperation	未授权操作。
UnsupportedOperation	操作不支持。