备案控制台
文档
产品文档
输入文档关键字查找
首页 云原生大数据计算服务 MaxCompute 操作指南 API参考 API目录 项目管理 基础管理（Project） GetProject - 获取项目信息

GetProject - 获取项目信息

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

查询MaxCompute项目的基本信息。

调试

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

授权信息

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

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

请求语法

GET /api/v1/projects/{projectName}

请求参数

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

项目名称。

odps_project
verboseboolean否

是否带有附加信息

true

返回参数

名称类型描述示例值
object

PopResult

requestIdstring

请求 id

0b87b7b316643495896551555e855b
httpCodeinteger

业务成功与否。如果非空且不是 200，那么表示业务处理失败。

200
errorCodestring

错误码

040002
errorMsgstring

错误信息

error message.
dataobject

返回数据

namestring

项目名称

odps_project
ownerstring

项目 owner

1565950907343451
typestring

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

managed
commentstring

备注

maxcompute项目
defaultQuotastring

默认计算 quota

quota_a
statusstring

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

AVAILABLE
productTypestring

计费模式

PayAsYouGo
threeTierModelboolean

当前 project 是否支持三层模型

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

无需关注

无需关注
enableTunnelQuotaRouteboolean

是否允许 tunnel quota 路由

true
storageTierInfoobject

分层存储信息

storageTierSizeobject

分层存储

standardSizelong

标准存储

27649172
longTermSizelong

长期存储

21764917
lowFrequencySizelong

低频存储

767693
projectTotalSizelong

总存储

56066037
projectBackupSizelong

备份存储

86672917
fdcQuotastring

fdc quota

enableFdcCacheForceboolean

是否强制开启 fdc 缓存

superAdminsarray

superadmin 角色成员

string

superadmin 角色成员

ALIYUN$***@aliyun.com
securityPropertiesobject

权限属性

usingAclboolean

是否使用 acl 权限

true
usingPolicyboolean

是否使用 Policy 授权

true
objectCreatorHasAccessPermissionboolean

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

true
objectCreatorHasGrantPermissionboolean

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

true
labelSecurityboolean

是否启动 Label 访问控制

false
enableDownloadPrivilegeboolean

是否开启 Download 权限

false
projectProtectionobject

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

exceptionPolicystring

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

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

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

true
ipWhiteListobject

ip 白名单

ipListstring

ip 白名单

10.88.111.3
vpcIpListstring

vpcip 白名单列表

10.88.111.3
saleTagobject

标签

resourceIdstring

资源 ID

project_name
resourceTypestring

资源类型

project

示例

正常返回示例

JSON格式

{
  "requestId": "0b87b7b316643495896551555e855b",
  "httpCode": 200,
  "errorCode": "040002",
  "errorMsg": "error message.",
  "data": {
    "name": "odps_project",
    "owner": "1565950907343451",
    "type": "managed",
    "comment": "maxcompute项目",
    "defaultQuota": "quota_a",
    "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": "SHA1",
        "key": "dafault"
      },
      "tunnelQuota": "Quota",
      "elderTunnelQuota": "无需关注",
      "enableTunnelQuotaRoute": true,
      "storageTierInfo": {
        "storageTierSize": {
          "standardSize": 27649172,
          "longTermSize": 21764917,
          "lowFrequencySize": 767693
        },
        "projectTotalSize": 56066037,
        "projectBackupSize": 86672917
      },
      "fdcQuota": "",
      "enableFdcCacheForce": true
    },
    "superAdmins": [
      "ALIYUN$***@aliyun.com"
    ],
    "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\":\"<Principal>\",\n        \"Action\":[\"odps:<Action1>[, <Action2>, ...]\"],\n        \"Resource\":\"acs:odps:*:<Resource>\",\n        \"Condition\":{\n            \"StringEquals\": {\n                \"odps:TaskType\":[\"<Tasktype>\"]\n            }\n        }\n    }]\n    }",
        "protected": true
      }
    },
    "ipWhiteList": {
      "ipList": "10.88.111.3",
      "vpcIpList": "10.88.111.3"
    },
    "saleTag": {
      "resourceId": "project_name",
      "resourceType": "project"
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2023-12-28OpenAPI 描述信息更新、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新。
入参OpenAPI 入参发生变更。
    新增入参：verbose
出参OpenAPI 返回结构发生变更。
2023-11-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2023-09-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
2023-09-14OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新。
出参OpenAPI 返回结构发生变更。
文档推荐
  • 本页导读 （1）
文档反馈