GetProject - 获取项目详情--资源管理-火山引擎

文档中心

立即注册

导航

GetProject - 获取项目详情

最近更新时间：2025.06.23 14:09:23首次发布时间：2023.08.24 21:41:32

获取项目详情

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetProject	要执行的操作，取值：GetProject。
Version	String	是	2021-08-01	API的版本，取值：2021-08-01。
ProjectName	String	是	project	项目名称。参数值中不能包含'.'或'..'；输入的字符长度必须在[1,64]区间；必须仅包含字母、数字、字符或以下符号：_-

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AccountID	Integer	2000000000	账号ID
ProjectName	String	project	项目名称
ParentProjectName	String	parentproject	父项目名称
Path	String	/project/	项目路径
DisplayName	String	display	展示名
Description	String	description	描述
CreateDate	String	20210826T120135Z	创建时间
UpdateDate	String	20211231T063223Z	创建时间
Status	String	active	状态

请求示例

GET /?Action=GetProject&Version=2021-08-01&ProjectName=project HTTP/1.1
Host: http://iam.volcengineapi.com/?Action=DetachPolicyInProject&Version=2021-08-01
X-Date: 20250618T123325Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250618/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025061820332906403002623616D408",
    "Action": "GetProject",
    "Version": "2021-08-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "AccountID": 2000000000,
    "ProjectName": "project",
    "ParentProjectName": "parentproject",
    "Path": "/project/",
    "DisplayName": "display",
    "Description": "description",
    "CreateDate": "20210826T120135Z",
    "UpdateDate": "20211231T063223Z",
    "Status": "active"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
404	EntityNotFound	The '%s' of '%v' is not found.	找不到对应的实体。请确认传入的实体参数是否真实存在
500	InternalError	The request processing has failed because of an internal error.	服务内部系统错误。往往是由服务内部组件异常、网络异常或服务自身bug导致，请及时联系相关管理员进行排查确认