文档

ListProjects - 获取项目列表

更新时间:

获取MaxCompute项目列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/projects

请求参数

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

租户 ID

549532154333697
regionstring

地域。

cn-beijing
quotaNickNamestring

Quota 名称。

quotaA
quotaNamestring

这是 quota 在 maxcompute 内部的标识,与 quotaNickname 有区别。quotaNickname 是用户设置的,quotaName 是系统自动生成的。这个字段仅用于描述数据通道 quota。

"hsajkdgbkaubh"
prefixstring

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

a
markerstring

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

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxIteminteger

每页返回的最大结果数。

10
saleTagsstring

描述了 MaxCompute quota 对象的标识,这个标识与阿里云售卖账单中的标识是一致的。实际使用与标签场景下。

"aaaa-bbbb"
typestring

这个 type 用于描述内部项目和外部项目。"external“ 表示外部项目,用于湖仓一体场景下。"managed" 表示内部项目。

"managed"
listSystemCatalogboolean

是否列出 SystemCatalog。

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

返回参数

名称类型描述示例值
object

PopResult<ListResultDTO<ProjectInfo, MarkerPageInfo>>

requestIdstring

请求 ID。

0b16399216671970335563173e2340
dataobject

返回数据。

projectsarray<object>

项目描述。

object

返回数据。

namestring

项目名称。

odps_project
ownerstring

项目 owner。

113981577560****
typestring

项目类型。 取值: -managed:内部项目。 -external:外部项目。

managed
commentstring

备注

MaxCompute项目
defaultQuotastring

默认计算 quota

quotaA
statusstring

项目状态。 取值: -AVAILABLE:正常 -READONLY:只读 -FROZEN:冻结 -DELETING:删除中

AVAILABLE
costStoragestring

存储量

16489027
regionIdstring

区域 ID

cn-beijing
createdTimelong

创建时间

1704380838000
propertiesobject

项目属性。

timezonestring

时区。

Asia/Shanghai
retentionDayslong

备份数据保留天数。

1
allowFullScanboolean

是否允许全表扫描。

false
typeSystemstring

数据类型版本。 取值: -1:1.0 版本 -2:2.0 版本 -hive:hive 兼容类型

2
enableDecimal2boolean

是否开启 decimal 2.0。

true
sqlMeteringMaxstring

sql 消费限制。

1500
tableLifecycleobject

表生命周期。

typestring

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

optional
valuestring

生命周期天数。

37231
encryptionobject

存储加密信息。

enableboolean

是否启用加密,取值:-true-false。

true
algorithmstring

加密算法名称。

SHA1
keystring

算法密钥名称。

dafault
tunnelQuotastring

tunnel Quota 名称。

quota_tunnel
enableTunnelQuotaRouteboolean

是否开启 tunnelQuota 路由。

true
securityPropertiesobject

权限属性。

usingAclboolean

是否使用 acl。

true
usingPolicyboolean

是否使用 Policy 授权。

true
objectCreatorHasAccessPermissionboolean

是否允许对象创建者操作对象。

true
objectCreatorHasGrantPermissionboolean

是否允许对象创建者授权对象。

true
labelSecurityboolean

是否启动 Label 访问控制。

false
enableDownloadPrivilegeboolean

是否开启 Download 权限。

false
projectProtectionobject

是否开启项目空间数据保护。

protectedboolean

是否开启项目空间数据保护。

true
exceptionPolicystring

ExceptionPolicy。项目所有者需要提前规划 Exception Policy,允许指定用户将指定对象的数据流出至指定项目,所有符合 Exception Policy 中描述的情形都可以打破数据保护机制。

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

IP 白名单

ipListstring

IP 白名单列表

10.88.111.3
vpcIpListstring

VPCID 白名单列表

10.88.111.3
saleTagobject

描述了 MaxCompute quota 对象的标识,这个标识与阿里云售卖账单中的标识是一致的。实际使用与标签场景下。

resourceIdstring

描述了 MaxCompute quota 对象的标识,这个标识与阿里云售卖账单中的标识是一致的。实际使用与标签场景下。

"aaaa-bbbb"
resourceTypestring

对象的类型,目前仅支持 quota 和 project 两种类型。

"project"
Tagsarray<object>

标签。

object

标签。

TagValuestring

标签值。

acceptance test
TagKeystring

标签键。

Department
threeTierModelboolean

当前 project 是否支持三层模型

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

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

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxIteminteger

每页返回的最大结果数。

10
NextTokenstring

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

AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb

示例

正常返回示例

JSON格式

{
  "requestId": "0b16399216671970335563173e2340",
  "data": {
    "projects": [
      {
        "name": "odps_project",
        "owner": "113981577560****",
        "type": "managed",
        "comment": "MaxCompute项目\n",
        "defaultQuota": "quotaA",
        "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": "SHA1",
            "key": "dafault"
          },
          "tunnelQuota": "quota_tunnel",
          "enableTunnelQuotaRoute": 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": "\"aaaa-bbbb\"",
          "resourceType": "\"project\""
        },
        "Tags": [
          {
            "TagValue": "acceptance test",
            "TagKey": "Department"
          }
        ],
        "threeTierModel": true
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
  }
}

错误码

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

变更历史

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