GetProject - 获取项目信息

查询MaxCompute项目的基本信息。

调试

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

授权信息

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

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

请求语法

GET /api/v1/projects/{projectName} HTTP/1.1

请求参数

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

项目名称。

odps_project
verboseboolean

是否带有附加信息

true

返回参数

名称类型描述示例值
object

请求返回参数。

requestIdstring

请求 ID。

0b87b7b316643495896551555e855b
httpCodeinteger

HTTP 状态码。

  • 1xx:信息响应 - 请求已接收,正在处理中。
  • 2xx:成功 - 请求动作已被服务端成功接收、理解并接受。
  • 3xx:重定向 - 请求被重定向,采取进一步行动以完成请求。
  • 4xx:客户端错误 - 请求包含错误请求参、语法或特定请求条件无法满足。
  • 5xx:服务端错误 - 服务器由于其他原因无法满足请求。
200
errorCodestring

错误码。

OBJECT_NOT_EXIST
errorMsgstring

错误信息。

This object does not exist.
dataobject

请求返回结果。

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
productTypestring

默认计算 Quota 的计费模式。

PayAsYouGo
threeTierModelboolean

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

true
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.0
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
elderTunnelQuotastring

项目绑定的数据传输服务资源组父组(无需关注)。

Default_p
enableTunnelQuotaRouteboolean

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

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

分层存储 信息。

storageTierSizeobject

分层存储 信息。

standardSizelong

标准存储用量。

27649172
longTermSizelong

长期存储用量。

21764917
lowFrequencySizelong

低频存储用量。

767693
projectTotalSizelong

总存储用量。

56066037
projectBackupSizelong

备份存储大小。

86672917
fdcQuotastring

外表缓存 Quota。

fdc_quota
enableFdcCacheForceboolean

是否强制开启外表缓存。

true
enableTieredStorageboolean

是否开启分层存储

true
tableLifecycleConfigobject

分层存储生命周期规则 属性,设置后系统将基于该规则触发分层存储类型自动转换。

TierToLongtermobject

长期存储标识。

DaysAfterLastModificationGreaterThanlong

距离数据最后修改时间超过多少天后自动设置,对应表或分区的LastModifiedTime

180
DaysAfterLastAccessGreaterThanlong

距离数据最后访问时间超过多少天后自动设置,对应表或分区的LastAccessTime

说明 若表或分区的 LastAccessTime 为空,则:
  • 对于 2023 年 10 月 01 日前创建的表或分区,默认按照 UTC+0 时区的 2023.10.01 00:00:00 时间计算。
  • 对于 2023 年 10 月 01 日后新建的表或分区,若数据没被访问过,按照 CreateTime 时间计算。
  • 180
    DaysAfterLastTierModificationGreaterThanlong

    距离上次转换存储类型的时间。

    1
    TierToLowFrequencyobject

    低频存储标识。

    DaysAfterLastModificationGreaterThanlong

    定义距离数据最后修改时间超过多少天后自动设置,对应表或分区的LastModifiedTime

    30
    DaysAfterLastAccessGreaterThanlong

    定义距离数据最后访问时间超过多少天后自动设置,对应表或分区的LastAccessTime

    说明 若表或分区的 LastAccessTime 为空,则:
  • 对于 2023 年 10 月 01 日前创建的表或分区,默认按照 UTC+0 时区的 2023.10.01 00:00:00 时间计算。
  • 对于 2023 年 10 月 01 日后新建的表或分区,若数据没被访问过,按照 CreateTime 时间计算。
  • 30
    DaysAfterLastTierModificationGreaterThanlong

    距离上次转换存储类型的时间。

    1
    externalProjectPropertiesobject

    外部项目属性。

    isExternalCatalogBoundstring

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

    true
    superAdminsarray

    项目的Super_Administrator角色成员列表。

    superAdminstring

    项目的Super_Administrator角色成员账号信息。

    RAM$odps****@aliyunid.com:RAM_USER
    securityPropertiesobject

    权限属性。

    usingAclboolean

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

    true
    usingPolicyboolean

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

    true
    objectCreatorHasAccessPermissionboolean

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

    true
    objectCreatorHasGrantPermissionboolean

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

    true
    labelSecurityboolean

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

    false
    enableDownloadPrivilegeboolean

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

    false
    projectProtectionobject
    exceptionPolicystring

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

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

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

    true
    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

    示例

    正常返回示例

    JSON格式

    {
      "requestId": "0b87b7b316643495896551555e855b",
      "httpCode": 200,
      "errorCode": "OBJECT_NOT_EXIST",
      "errorMsg": "This object does not exist.",
      "data": {
        "name": "odps_project",
        "owner": "ALIYUN$odps****@aliyunid.com",
        "type": "managed",
        "comment": "BI_Analysis",
        "defaultQuota": "os_PayAsYouGoQuota",
        "status": "AVAILABLE",
        "productType": "PayAsYouGo",
        "threeTierModel": true,
        "costStorage": "16489027",
        "regionId": "cn-beijing",
        "createdTime": 1704380838000,
        "properties": {
          "timezone": "Asia/Shanghai",
          "retentionDays": 1,
          "allowFullScan": false,
          "typeSystem": "2.0",
          "enableDecimal2": true,
          "sqlMeteringMax": "1500",
          "tableLifecycle": {
            "type": "optional",
            "value": "37231"
          },
          "encryption": {
            "enable": true,
            "algorithm": "AES256",
            "key": "dafault"
          },
          "tunnelQuota": "Default",
          "elderTunnelQuota": "Default_p",
          "enableTunnelQuotaRoute": true,
          "storageTierInfo": {
            "storageTierSize": {
              "standardSize": 27649172,
              "longTermSize": 21764917,
              "lowFrequencySize": 767693
            },
            "projectTotalSize": 56066037,
            "projectBackupSize": 86672917
          },
          "fdcQuota": "fdc_quota",
          "enableFdcCacheForce": true,
          "enableTieredStorage": true,
          "tableLifecycleConfig": {
            "TierToLongterm": {
              "DaysAfterLastModificationGreaterThan": 180,
              "DaysAfterLastAccessGreaterThan": 180,
              "DaysAfterLastTierModificationGreaterThan": 1
            },
            "TierToLowFrequency": {
              "DaysAfterLastModificationGreaterThan": 30,
              "DaysAfterLastAccessGreaterThan": 30,
              "DaysAfterLastTierModificationGreaterThan": 1
            }
          },
          "externalProjectProperties": {
            "isExternalCatalogBound": "true"
          }
        },
        "superAdmins": [
          "RAM$odps****@aliyunid.com:RAM_USER\n"
        ],
        "securityProperties": {
          "usingAcl": true,
          "usingPolicy": true,
          "objectCreatorHasAccessPermission": true,
          "objectCreatorHasGrantPermission": true,
          "labelSecurity": false,
          "enableDownloadPrivilege": false,
          "projectProtection": {
            "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}",
            "protected": true
          }
        },
        "ipWhiteList": {
          "ipList": "10.88.111.3",
          "vpcIpList": "10.88.111.3"
        },
        "saleTag": {
          "resourceId": "b7afb7d1-****-****-****-c393669c307b",
          "resourceType": "PayAsYouGo"
        }
      }
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-09-12OpenAPI 返回结构发生变更查看变更详情
    2024-07-11API 内部配置变更,不影响调用查看变更详情
    2024-06-25OpenAPI 返回结构发生变更查看变更详情
    2024-06-24OpenAPI 返回结构发生变更查看变更详情
    2024-06-24OpenAPI 返回结构发生变更查看变更详情
    2024-04-17OpenAPI 返回结构发生变更查看变更详情
    2024-01-08OpenAPI 返回结构发生变更查看变更详情
    2023-12-28OpenAPI 描述信息更新、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-11-21OpenAPI 返回结构发生变更查看变更详情
    2023-09-21OpenAPI 返回结构发生变更查看变更详情
    2023-09-14OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情