数据开发治理平台 WeData 获取租户全局范围的项目列表

1. 接口描述

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

租户全局范围的项目列表，与用户查看范围无关.

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTenantProjects。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
PageNumber	是	Integer	第几页示例值：1
PageSize	是	Integer	一页几条示例值：10
DescribeExecutors	否	Boolean	是否展示关联执行组的信息。正常应该不是从项目列表里获取示例值：true
DescribeAdminUsers	否	Boolean	是否展示项目管理员信息，减少默认返回的请求内容示例值：true
DescribeMemberCount	否	Boolean	统计项目人员数量。数据地图需求示例值：true
Filters.N	否	Array of Filter	自定义条件查询
OrderFields.N	否	Array of OrderField	排序字段
DescribeCreator	否	Boolean	默认不提供创建者信息，该参数与CAM交互比较耗时示例值：fasle
DescribeResourcePools	否	Boolean	是否展示关联资源池信息示例值：false

3. 输出参数

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

4. 示例

示例1 describe creator

输入示例

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

{
    "PageNumber": "0",
    "DescribeCreator": "true",
    "PageSize": "10"
}

输出示例

{
    "Response": {
        "Data": {
            "PageNumber": 1,
            "PageSize": 1,
            "Rows": [
                {
                    "TenantId": "1",
                    "ProjectId": "1990",
                    "ProjectName": "admin",
                    "DisplayName": "admin",
                    "Region": "beijing",
                    "Description": "beijing",
                    "CreateTime": "2020-09-22T00:00:00+00:00",
                    "Creator": {
                        "UserId": "199199",
                        "UserName": "zhangsan",
                        "DisplayName": "zhangsan"
                    },
                    "Tenant": {
                        "TenantId": "1",
                        "TenantName": "zhangsan",
                        "DisplayName": "zhangsan",
                        "Description": "zhangsan",
                        "OwnerUserId": "zhangsan",
                        "Params": "zhangsan"
                    },
                    "AdminUsers": [
                        {
                            "UserId": "1999",
                            "UserName": "zhangsan",
                            "DisplayName": "zhangsan"
                        }
                    ],
                    "Clusters": [
                        {
                            "ClusterId": "zhangsan",
                            "ClusterType": "zhangsan",
                            "ClusterName": "zhangsan",
                            "RegionCn": "zhangsan",
                            "RegionEn": "zhangsan",
                            "RegionArea": "zhangsan",
                            "Used": true,
                            "Status": 1,
                            "StatusInfo": "zhangsan",
                            "StorageType": "zhangsan",
                            "ComputeType": "zhangsan",
                            "ClusterResource": "zhangsan",
                            "ChargeType": "zhangsan",
                            "CreateTime": "2020-09-22T00:00:00+00:00",
                            "ExtraConf": "zhangsan",
                            "RangerUserName": "zhangsan",
                            "CdwUserName": "zhangsan"
                        }
                    ],
                    "Params": "zhangsan",
                    "Status": 1
                }
            ],
            "TotalCount": 1,
            "TotalPageNumber": 1
        },
        "RequestId": "zhangsan"
    }
}

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. 错误码

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

错误码	描述
FailedOperation	操作失败。
OperationDenied.UserNotInWhitelistError	用户不在白名单。

获取租户全局范围的项目列表

本页目录：