全部产品
Search
文档中心

云原生大数据计算服务 MaxCompute:ListProjects - 获取项目列表

更新时间:Nov 11, 2024

获取MaxCompute项目列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
odps:ListProjectslist
  • Project
    acs:odps:{#regionId}:{#accountId}:projects/*

请求语法

GET /api/v1/projects HTTP/1.1

请求参数

名称类型必填描述示例值
tenantIdstring

租户 ID。可以通过登录 MaxCompute 控制台,在左侧导航栏选择租户管理>租户属性查看。

5495****3697
regionstring

地域 ID。

cn-beijing
quotaNickNamestring

Quota 昵称(可通过登录 MaxCompute 控制台,在左侧导航栏选择工作区>配额(Quota)管理查看获取)。

os_PayAsYouGoQuota
quotaNamestring

Quota 名称(系统自动生成,可通过登录 MaxCompute 控制台,在左侧导航栏选择工作区>配额(Quota)管理查看获取)。

aliyun_5495***3697
prefixstring

限定返回的资源名称,名称必须以 Prefix 作为前缀,例如 Prefix 是 a,则返回的资源名均是以 a 开始的。

a
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxIteminteger

每页返回的最大结果数,默认为 10。

10
saleTagsstring

默认计算 Quota 的实例 ID 与付费类型。

{ "resourceId": "b7afb7d1-****-****-****-c393669c307b", "resourceType": "PayAsYouGo" }
typestring

项目类型。取值:

  • managed:内部项目。
  • external:外部项目。
managed
listSystemCatalogboolean

是否列出内建SYSTEM_CATALOG项目,用于提供项目元数据及使用历史数据等信息,详细请参考 Information Schema功能。

枚举值:
  • true列出
  • false不列出
true

返回参数

名称类型描述示例值
object

请求返回参数。

requestIdstring

请求 ID。

0b16399216671970335563173e2340
dataobject

请求返回结果。

projectsarray<object>

项目列表。

projectsobject

项目信息。

namestring

项目名称。

odps_project
ownerstring

项目 owner 账号信息。

ALIYUN$odps****@aliyunid.com
typestring

项目类型。取值:

  • managed:内部项目。
  • external:外部项目。
managed
commentstring

项目描述。

BI_Analysis
defaultQuotastring

默认计算 Quota。 用于实现计算资源分配。不指定计算 Quota 的情况下,该项目发起的作业将消耗默认 Quota 资源。更多计算资源使用请参见 计算资源-Quota 使用

os_PayAsYouGoQuota
statusstring

项目状态。取值:

  • AVAILABLE:正常
  • READONLY:只读
  • FROZEN:冻结
  • DELETING:删除中
AVAILABLE
costStoragestring

存储总量。 查看项目当前存储大小,此存储量与计量口径一致,即按 Project 采集压缩后的逻辑存储大小。

16489027
regionIdstring

地域 ID。

cn-beijing
createdTimelong

创建时间。

1704380838000
propertiesobject

项目基础属性。

timezonestring

项目时区,即为odps.sql.timezone属性。

Asia/Shanghai
retentionDayslong

备份数据的保留天数。在此期间,您可以将当前版本恢复至任意一个备份的数据版本。 取值范围为[0,30],默认值为 1,0 代表关闭备份功能。

1
allowFullScanboolean

项目空间是否允许全表扫描。全表扫描会占用大量资源,为提升处理效率,默认关闭该功能。

false
typeSystemstring

数据类型版本。取值:

  • 1:1.0 版本
  • 2:2.0 版本
  • hive:hive 兼容类型

三种数据类型版本的区别请参见 数据类型版本说明

2
enableDecimal2boolean

项目是否开启 MaxCompute 2.0 的 Decimal 数据类型。

true
sqlMeteringMaxstring

单 SQL 消费的最高阈值。 单位:扫描量(GB)*复杂度。

1500
tableLifecycleobject

表的生命周期属性。

typestring

生命周期类型。取值:

  • mandatory:Lifecycle 子句为必选设置,用户必须设置表的生命周期。
  • optional:创建表时,Lifecycle 子句为可选设置,如果不设置表的生命周期,则该表永远有效。
  • inherit:创建表时,如果不设置表的生命周期,则该表的生命周期为 odps.table.lifecycle.value 的值。
optional
valuestring

表的生命周期,单位为:天。取值范围为 1~37231,默认值为 37231。

37231
encryptionobject

存储加密属性。

enableboolean

项目是否开启数据加密功能。更多数据加密信息,请参见

存储加密

true
algorithmstring

数据加密算法:密钥支持的加密算法,包含 AES256、AESCTR 和 RC4。

AES256
keystring

数据加密使用的密钥类型,包含默认密钥(MaxCompute Default Key)和自带密钥(BYOK)。默认密钥(MaxCompute Default Key)是 MaxCompute 内部创建的默认密钥。

dafault
tunnelQuotastring

项目绑定的 数据传输服务资源组。

  • Default(数据传输服务共享资源组):该项目不允许使用数据传输服务(包年包月)资源组。不管开启成默认数据传输服务资源组取值是什么,该项目默认提交的数据传输服务会自动使用 Default 资源组。

  • 数据传输服务(包年包月)资源组:该项目允许使用数据传输服务(包年包月)资源组。

Default
enableTunnelQuotaRouteboolean

是否开启数据传输服务资源组路由。

  • true:表示该项目默认提交的数据传输任务会使用绑定的数据传输服务资源组。
  • false:表示该项目默认提交的数据传输任务会使用数据传输服务共享资源组。
true
externalProjectPropertiesobject

外部项目属性。

isExternalCatalogBoundstring

是否为 湖仓一体 2.0外部项目。

true
securityPropertiesobject

权限属性。

usingAclboolean

是否使用 ACL 权限控制功能,默认为使用状态。

true
usingPolicyboolean

是否使用 Policy 权限控制功能,默认为使用状态。

true
objectCreatorHasAccessPermissionboolean

是否允许对象创建者拥有对象的访问权限,默认为允许状态。

true
objectCreatorHasGrantPermissionboolean

是否允许对象创建者拥有对象的授权权限,默认为允许状态。

true
labelSecurityboolean

是否使用 Label 权限控制功能,默认为不使用状态。

false
enableDownloadPrivilegeboolean

是否使用 Download 权限控制功能,默认为不使用状态。

false
projectProtectionobject
protectedboolean

是否开启项目的 数据保护机制,禁止或允许数据流出项目,默认为不开启状态。

true
exceptionPolicystring

如选择开启项目空间数据保护,允许设置例外或受信任项目,指定用户将指定对象的数据流出至指定项目,所有符合 Exception Policy 中描述的情形都可以打破数据保护机制。

{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
ipWhiteListobject

IP 白名单。

ipListstring

公网和云产品互联网络 IP 白名单。

说明 如果只配置公网和云产品互联网络 IP 白名单,则公网和云产品互联网络访问受配置限制,VPC 网络访问全部禁止。
10.88.111.3
vpcIpListstring

VPC 网络 IP 白名单。

说明 如果只配置 VPC 网络 IP 白名单,则 VPC 网络访问受配置限制,公网和云产品互联网络访问全部禁止。
10.88.111.3
saleTagobject

默认计算 Quota 的实例 ID 与付费类型。

resourceIdstring

默认计算 Quota 的实例 ID。

b7afb7d1-****-****-****-c393669c307b
resourceTypestring

默认计算 Quota 的付费类型。

PayAsYouGo
threeTierModelboolean

是否支持按 Schema 存储。 MaxCompute 支持 Schema,处于 Project 下,Table、Resource、UDF 上的对象,对 Table、Resource、UDF 进行归类。一个 Project 下可以有多个 Schema。详情请参见 Schema 操作

枚举值:
  • true支持
  • false不支持
true
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxIteminteger

每页返回的最大结果数。

10
NextTokenstring

分页标识,当前接口仅支持连续翻页。返回值 nextToken 非空代表还有剩余数据。把 nextToken 作为参数继续查询会获得下一页。

AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb

示例

正常返回示例

JSON格式

{
  "requestId": "0b16399216671970335563173e2340",
  "data": {
    "projects": [
      {
        "name": "odps_project",
        "owner": "ALIYUN$odps****@aliyunid.com\n",
        "type": "managed",
        "comment": "BI_Analysis",
        "defaultQuota": "os_PayAsYouGoQuota\n",
        "status": "AVAILABLE",
        "costStorage": "16489027",
        "regionId": "cn-beijing",
        "createdTime": 1704380838000,
        "properties": {
          "timezone": "Asia/Shanghai\n",
          "retentionDays": 1,
          "allowFullScan": false,
          "typeSystem": "2",
          "enableDecimal2": true,
          "sqlMeteringMax": "1500",
          "tableLifecycle": {
            "type": "optional",
            "value": "37231\n"
          },
          "encryption": {
            "enable": true,
            "algorithm": "AES256",
            "key": "dafault"
          },
          "tunnelQuota": "Default",
          "enableTunnelQuotaRoute": true,
          "externalProjectProperties": {
            "isExternalCatalogBound": "true"
          }
        },
        "securityProperties": {
          "usingAcl": true,
          "usingPolicy": true,
          "objectCreatorHasAccessPermission": true,
          "objectCreatorHasGrantPermission": true,
          "labelSecurity": false,
          "enableDownloadPrivilege": false,
          "projectProtection": {
            "protected": true,
            "exceptionPolicy": "{\n      \"Version\": \"1\",\n      \"Statement\": [\n            {\n                  \"Effect\": \"Allow\",\n                  \"Principal\": \"\",\n                  \"Action\": [\n                        \"odps:[, , ...]\"\n                  ],\n                  \"Resource\": \"acs:odps:*:\",\n                  \"Condition\": {\n                        \"StringEquals\": {\n                              \"odps:TaskType\": [\n                                    \"\"\n                              ]\n                        }\n                  }\n            }\n      ]\n}"
          }
        },
        "ipWhiteList": {
          "ipList": "10.88.111.3",
          "vpcIpList": "10.88.111.3"
        },
        "saleTag": {
          "resourceId": "b7afb7d1-****-****-****-c393669c307b\n",
          "resourceType": "PayAsYouGo\n"
        },
        "threeTierModel": true
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-12OpenAPI 返回结构发生变更查看变更详情
2024-07-31OpenAPI 返回结构发生变更查看变更详情
2024-01-08OpenAPI 返回结构发生变更查看变更详情
2023-11-14OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-09-21OpenAPI 返回结构发生变更查看变更详情
2023-08-23OpenAPI 入参发生变更查看变更详情