QueryProject - 查询项目信息

更新时间:

阿里云控制台/获取项目列表

调试

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

授权信息

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

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

请求语法

GET /api/v1/aliyunConsole/queryProject HTTP/1.1

请求参数

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

项目 id

123

返回参数

名称类型描述示例值
object

SingleResponse

requestIdstring

请求编号

xxxx-xxxx-xxxx-xxxxxxxx
successboolean

是否成功

true
errCodestring

错误信息编码

UNKNOWN_ERROR
errMessagestring

错误信息

未知错误
httpStatusCodeinteger

http 状态码

200
dataobject

数据对象

ProjectIdstring

项目 ID

67055
ProjectNamestring

项目名称

MyProject
ProjectTypestring

项目类型

WebApplication
ProjectAppsarray<object>

项目应用列表

ProjectAppobject

项目应用

Idstring

应用内部 id

2144
ApplicationAccessIdsarray<object>

应用访问凭证

ApplicationAccessIdobject
applicationAccessIdstring

应用识别码、appkey

1234567890
applicationAccessSecretstring

应用秘钥,只有控制台请求才会返回

MyAppSecret
ProjectIdstring

项目 id

159
ProjectSDKarray<object>

项目 SDK

ProjectSDKobject
SdkNamestring

SDK 名称

JSSDK
DeployModestring

部署模式:客户端或者服务端

服务端
DevelopLanguagestring

开发语言

JAVA
SdkUrlstring

SDK 地址

http://demo.com/sdk.zip
DocUrlstring

文档地址

http://demo.com/doc
DemoUrlstring

demo 地址

http://demo.com/demo
SdkVersionstring

SDK 版本

5.1.0
CreateTimestring

创建时间

2024-11-01T13:40:53Z
CreateTimestring

创建时间

2024-11-01T13:40:53Z

示例

正常返回示例

JSON格式

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": {
    "ProjectId": 67055,
    "ProjectName": "MyProject",
    "ProjectType": "WebApplication",
    "ProjectApps": [
      {
        "Id": 2144,
        "ApplicationAccessIds": [
          {
            "applicationAccessId": 1234567890,
            "applicationAccessSecret": "MyAppSecret"
          }
        ],
        "ProjectId": 159
      }
    ],
    "ProjectSDK": [
      {
        "SdkName": "JSSDK",
        "DeployMode": "服务端",
        "DevelopLanguage": "JAVA",
        "SdkUrl": "http://demo.com/sdk.zip",
        "DocUrl": "http://demo.com/doc",
        "DemoUrl": "http://demo.com/demo",
        "SdkVersion": "5.1.0",
        "CreateTime": "2024-11-01T13:40:53Z"
      }
    ],
    "CreateTime": "2024-11-01T13:40:53Z"
  }
}

错误码

HTTP status code错误码错误信息
403B_PERMISSION_DENIED_EXCEPTION鉴权失败或权限不足
500UNKNOWN_ERRORThe request processing has failed due to some unknown error.

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