DocsICP FilingConsole
官方文档
首页

QueryProject

更新时间：
复制 MD 格式
产品详情
我的收藏

Alibaba Cloud console / Project list

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aicontent:QueryProject

get

*All Resource

*

 None None

Request syntax

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

Request parameters

Parameter

Type

Required

Description

Example
projectId

string

No

The ID of the project.

123

Response elements

Element

Type

Description

Example

object

The response object.

{ "success": true, “data":{ "appId": "a123", "deviceType": "iOS", "deployType": "server", "devLanguage": "java", "sdkVersion": "1.0.0", "sdkUrl": "http://www.xxx.com/abc.tgz", "sdkMd5": "1234567890", "sdkName": "XXAppIdServerSDK2024" }, "requestId": "592A27EF-26D3-1434-98C1-97AD63337852" }
requestId

string

The request ID.

xxxx-xxxx-xxxx-xxxxxxxx
success

boolean

Indicates if the request was successful.

true
errCode

string

The error code.

UNKNOWN_ERROR
errMessage

string

The error message.

未知错误
httpStatusCode

integer

The HTTP status code.

200
data

object

The returned data, which contains the details of the project.

[]
ProjectId

string

The project ID.

67055
ProjectName

string

The project name.

MyProject
ProjectType

string

The project type.

WebApplication
ProjectApps

array<object>

The list of applications in the project.

array<object>

An application within the project.

Id

string

The application ID.

2144
ApplicationAccessIds

array<object>

The application access credentials.

object

applicationAccessId

string

The application ID, also known as the AppKey.

1234567890
applicationAccessSecret

string

The application secret. This parameter is returned only for requests from the console.

MyAppSecret
ProjectId

string

The project ID.

159
ProjectSDK

array<object>

The list of SDKs associated with the project.

object

SdkName

string

The SDK name.

JSSDK
DeployMode

string

The deployment mode. Valid values: client or server.

服务端
DevelopLanguage

string

The development language. For example: JAVA.

JAVA
SdkUrl

string

The SDK URL.

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

string

The document URL.

http://demo.com/doc
DemoUrl

string

The demo URL.

http://demo.com/demo
SdkVersion

string

The SDK version.

5.1.0
CreateTime

string

The creation time.

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

string

The creation time.

2024-11-01T13:40:53Z

Examples

Success response

JSON format

{
  "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"
  }
}

Error codes

HTTP status code

Error code

Error message

Description
500 UNKNOWN_ERROR The request processing has failed due to some unknown error.
403 B_PERMISSION_DENIED_EXCEPTION 鉴权失败或权限不足

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：QueryProjectListNext：CreateProject