Help Center> API Gateway> API Reference> Shared Gateway APIs (for Existing Users)> App Management> Querying an AppCode List
View PDF

Querying an AppCode List

Function

This API is used to query a list of AppCodes that match specified conditions.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

Table 1 HTTP/HTTPS request method and URI

Request Method

URI

GET

/v1.0/apigw/apps/{app_id}/app-codes/[?page_size, page_no]
  • A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
  • Query conditions include: page_size and page_no.

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

app_id

Yes

String

App ID

Request

N/A

Response

Table 3 Parameter description

Parameter

Type

Description

total

Integer

Number of apps that match the query conditions

size

Integer

Length of the returned AppCode list

app_codes

Dictionary

AppCode list
Table 4 Parameter description of app_codes

Parameter

Type

Description

id

String

AppCode ID

app_code

String

AppCode value

app_id

String

App ID

create_time

Timestamp

Time when the AppCode is created

Example response:

{
    "total": 4,
    "size": 4,
    "app_codes": [
        {
            "app_code": "7049bc6b5b4140b4a93340f2555641bbc4cc7179e7734baeb85a773041cbfb1a",
            "id": "5434c97d872f41a88b039a8a973e0652",
            "app_id": "db246f3f2ecd45f29ecb0f305e821fdc",
            "create_time": "2019-06-05T08:54:25Z"
        },
        {
            "app_code": "asdssdadasdsssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss",
            "id": "787860297c3d4e51b76fff8abd089a94",
            "app_id": "db246f3f2ecd45f29ecb0f305e821fdc",
            "create_time": "2019-06-05T04:56:51Z"
        },
        {
            "app_code": "MeOAgeemgeatouS7peiwg+ivleaooeW8j+aJp+ihjHNoZWxs6ISa5pysICAgLS0tLS0tLS3lronoo4XljIXmrovnlZnvvIzkuIvkuKrniYjmnKzlop7liqDpg6jnvbLlronoo4XljIXliKDpmaQ22222221234124",
            "id": "c7a87cdfa50b4a4eaa644901c4dddb98",
            "app_id": "db246f3f2ecd45f29ecb0f305e821fdc",
            "create_time": "2019-05-10T03:14:02Z"
        },
        {
            "app_code": "MeOAgeemgeatouS7peiwg+ivleaooeW8j+aJp+ihjHNoZWxs6ISa5pysICAgLS0tLS0tLS3lronoo4XljIXmrovnlZnvvIzkuIvkuKrniYjmnKzlop7liqDpg6jnvbLlronoo4XljIXliKDpmaQ",
            "id": "7be28fde162b4186a9a07543ca48a28e",
            "app_id": "db246f3f2ecd45f29ecb0f305e821fdc",
            "create_time": "2019-05-10T03:13:27Z"
        }
    ]
}

Status Codes

Table 5 Status codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

500

Server Internal Error
Parent topic: App Management