Querying the Message List

Description

This API is used to query the list of notification messages in the review center. Different from applications, notification messages cannot be rejected and can be processed only within a specified time period.

URL

URI format
GET /v1/{project_id}/service/messages[?offset,limit,api_name]

Parameter description

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
offset	No	Integer	Query start coordinate, that is, skipping the first X records. The value can only be 0 or an integer multiple of limit. If the requirement is not met, the value is rounded down. The default value is 0. The value range is [0, MAX_INTEGER).
limit	No	Integer	Number of records to be queried, that is, Y records. The default value is 100. The value range is [1, 100].
api_name	No	String	API name

Request Message

Example request
None

Response

Example response

{
  "total": 1,
  "records": [
    {
      "id": "a1c93c3cb17d9747fc41df0377b6fe0f",
      "api_apply_status": "STATUS_TYPE_PASSED",
      "api_apply_type": "APPLY_TYPE_APPLY",
      "api_id": "47046fe7830c1be77cb0dc23bd86afa5",
      "api_name": "api_demo",
      "api_using_time": 1580452617000,
      "app_id": "908489209a320df61607355c57c82882",
      "app_name": "app_demo",
      "apply_time": 1578875421000,
      "approval_time": 1578897421000,
      "approver_name": "Jack",
      "comment": "Pass",
      "user_name": "Tim"
    }
  ]
}

Response parameter description

Parameter	Type	Description
total	Integer	Number of messages that match the query conditions
records	Dictionary	Messages that are returned

records parameter description

Parameter	Type	Description
id	String	Application ID
api_apply_status	String	Application status. Available values include: STATUS_TYPE_PENDING_APPROVAL: The application is pending review. STATUS_TYPE_REJECTED: The application has been rejected. STATUS_TYPE_PENDING_CHECK: The application is pending check. STATUS_TYPE_PENDING_EXECUTE: The application is pending execution. STATUS_TYPE_SYNCHRONOUS_EXECUTE: The application is synchronously executed. STATUS_TYPE_FORCED_CANCEL: The application has been forcibly canceled. STATUS_TYPE_PASSED: The application has been approved.
api_apply_type	String	Application type. Available values include: APPLY_TYPE_PUBLISH: publishing an API APPLY_TYPE_AUTHORIZE: authorizing an API APPLY_TYPE_APPLY: applying for authorization APPLY_TYPE_RENEW: applying for renewing the validity period APPLY_TYPE_STOP: suspending an API APPLY_TYPE_RECOVER: restoring an API APPLY_TYPE_API_CANCEL_AUTHORIZE: canceling API authorization (by the API reviewer) APPLY_TYPE_APP_CANCEL_AUTHORIZE: canceling API authorization (by the app owner) APPLY_TYPE_OFFLINE: unpublishing an API
api_id	String	API ID
api_name	String	API name
api_using_time	Long	Expiry time of using the API, which is a 13-digit timestamp
app_id	String	App ID
app_name	String	App name
apply_time	Long	Application time, which is a 13-digit timestamp
approval_time	Long	Authorization time, which is a 13-digit timestamp
approver_name	String	Reviewer name
comment	String	Review comment
user_name	String	Applicant name