Querying Apps
Function
This API is used to query apps.
URI
GET /v2/{project_id}/apps
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Maximum number of apps to list in a single API call Range: 1 to 100 Default value: 10 Minimum: 1 Maximum: 100 Default: 10 |
start_app_name |
No |
String |
Name of the app to start the list with. The returned app list does not contain this app name. |
stream_name |
No |
String |
Name of the stream whose apps will be returned. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
has_more_app |
Boolean |
Whether there are more matching consumer applications
|
apps |
Array of DescribeAppResult objects |
AppEntry list that meets the current request. |
total_number |
Integer |
Total number of apps that meet criteria. |
Example Requests
Querying Apps
GET https://{Endpoint}/v2/{project_id}/apps
Example Responses
Status code: 200
Normal response.
{ "total_number" : 1, "apps" : [ { "app_id" : "bd6IPpvgiIflQPMpi9M", "app_name" : "newstream", "create_time" : 1593569685875 } ], "has_more_app" : true }
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response. |
400 |
Invalid Parameters |
404 |
Application not found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot