All Products
Search
Document Center

CloudOps Orchestration Service:ListApplications

Last Updated:Oct 14, 2024

Queries a list of applications. You can call this operation only for the applications that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oos:ListApplicationslist
  • Application
    acs:oos:{#regionId}:{#accountId}:application/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID. Set the value to cn-hangzhou.

cn-hangzhou
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 10 to 100. Default value: 50.

10
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results.

-
TagsobjectNo

The tags.

{"k1": "v1","k2": "v2"}
NamesstringNo

The names of the applications.

["MyApplication"]
NamestringNo

The name of the application.

"MyApplications"
ApplicationTypestringNo

The type of the application.

Valid values:

  • ComputeNest

  • Custom

  • DingTalk

DingTalk

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The pagination token that is used in the next request to retrieve a new page of results.

-
RequestIdstring

The ID of the request.

12067D53-56A9-561B-ADD6-61429D207117
MaxResultsinteger

The number of entries returned per page.

10
Applicationsarray<object>

The details of the application.

Applicationobject
Descriptionstring

The description of the application.

Application
UpdateDatestring

The time when the application was updated.

2021-09-07T09:09:59Z
ResourceGroupIdstring

The resource group ID.

rg-acfmxsn4m******
Tagsobject

The tags added to the application.

{"k1": "v1","k2": "v2"}
Namestring

The name of the application.

MyApplication
CreateDatestring

The time when the application was created.

2021-09-07T09:09:59Z
ApplicationTypestring

The type of the application.

DingTalk

Examples

Sample success responses

JSONformat

{
  "NextToken": "-",
  "RequestId": "12067D53-56A9-561B-ADD6-61429D207117",
  "MaxResults": 10,
  "Applications": [
    {
      "Description": "Application",
      "UpdateDate": "2021-09-07T09:09:59Z",
      "ResourceGroupId": "rg-acfmxsn4m******",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "Name": "MyApplication",
      "CreateDate": "2021-09-07T09:09:59Z",
      "ApplicationType": "DingTalk"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-06-12The request parameters of the API has changed. The response structure of the API has changedView Change Details
2022-03-18The request parameters of the API has changedView Change Details