ListApps

更新时间:
复制 MD 格式

Get the list of applications.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ClusterId

string

Yes

The cluster ID.

AppName

string

No

The application name.

Title

string

No

The title.

PageNum

integer

No

The page number.

1

PageSize

integer

No

The page size.

20

Response elements

Element

Type

Description

Example

object

The response schema.

Code

integer

The response code.

Message

string

The error message.

RequestId

string

The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot issues.

Success

boolean

Indicates whether the call was successful.

  • true: the call was successful.

  • false: the call failed.

Data

object

Records

array<object>

object

Id

integer

The primary key ID.

AppName

string

The application name.

AccessToken

string

The AccessToken.

Title

string

The title.

Creator

string

The creator.

Updater

string

The updater.

Leader

string

The leader address.

MaxJobs deprecated

integer

The maximum number of jobs.

MaxConcurrency

integer

The maximum concurrency.

JobNum

integer

The number of jobs.

ExecutorNum

integer

The number of executors.

EnableLog

boolean

Indicates whether logging is enabled.

  • true: enabled.

  • false: disabled.

LabelRouteStrategy

integer

The label routing strategy.

1

AppType

integer

The application type.

1

WorkerType

string

The worker type.

openclaw

WorkflowNum

integer

The current number of workflows.

3

WorkerRegistry

string

The manual executor registration type.

WorkerId

integer

The worker group ID.

1

Total

integer

The total number of entries.

10

PageNumber

integer

The page number.

PageSize

integer

The number of entries per page.

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "",
  "RequestId": "",
  "Success": false,
  "Data": {
    "Records": [
      {
        "Id": 0,
        "AppName": "",
        "AccessToken": "",
        "Title": "",
        "Creator": "",
        "Updater": "",
        "Leader": "",
        "MaxJobs": 0,
        "MaxConcurrency": 0,
        "JobNum": 0,
        "ExecutorNum": 0,
        "EnableLog": false,
        "LabelRouteStrategy": 1,
        "AppType": 1,
        "WorkerType": "openclaw",
        "WorkflowNum": 3,
        "WorkerRegistry": "",
        "WorkerId": 1
      }
    ],
    "Total": 10,
    "PageNumber": 0,
    "PageSize": 0
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter Parameter error: %s. Parameter error: %s
401 IllegalRequest IllegalRequest: %s. Illegal request:%s
500 InternalError InternalError: %s. System Internal Error: %s
403 NoPermission No permission to perform this operation: %s. No permission to perform this operation: %s
404 NotFound Not found: %s. The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.