Updated on 2022-09-15 GMT+08:00

Querying API Overview

Function

This API is used to query API overview.

URI

GET /v1/{project_id}/service/statistic/apis-overview

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

start_time

Yes

Long

Start time, which is a 13-digit timestamp

end_time

Yes

Long

End time, which is a 13-digit timestamp

time_unit

Yes

String

Time unit

Enumeration values:

  • HOUR

  • DAY

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM Token

Workspace

No

String

Workspace ID

Dlm-Type

Yes

String

DLM edition

Enumeration values:

  • SHARED

  • EXCLUSIVE

Response Parameters

Status code: 204

Table 4 Response body parameters

Parameter

Type

Description

publish_num

Integer

Number of published APIs

developing_num

Integer

Number of APIs being developed

apply_num

Integer

Number of applications

call_num

Integer

Number of calls

success_num

Integer

Number of successful calls (data obtained)

fail_num

Integer

Number of failed calls (failed to obtain data)

legal_num

Integer

Number of legal calls (verification passed)

illegal_num

Integer

Number of illegal calls (failed to pass verification)

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

None

Example Responses

Status code: 204

The API overview is obtained.

{
  "publish_num" : 54,
  "developing_num" : 117,
  "apply_num" : 4,
  "call_num" : 10,
  "success_num" : 9,
  "fail_num" : 1,
  "legal_num" : 10,
  "illegal_num" : "0\r"
}

Status Codes

Status Code

Description

204

The API overview is obtained.

400

BadRequest