Obtaining the Overview Information

Description

This API is used to obtain the overview information of the current user.

URI

GET /v1/{project_id}/node-provider/summary

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum length: 32 characters Maximum length: 32 characters

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Minimum length: 1 character Maximum length: 65,535 characters

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
chain	Integer	Network type. Minimum value: 0 Maximum value: 2,147,483,647
node	Integer	Number of nodes. Minimum value: 0 Maximum value: 2,147,483,647
full_node	Integer	Number of full nodes. Minimum value: 0 Maximum value: 2,147,483,647
staking	Integer	Number of staking nodes. Minimum value: 0 Maximum value: 2,147,483,647
call	Integer	Number of calls. Minimum value: 0 Maximum value: 2,147,483,647
alarm	Integer	Number of alarms. Minimum value: 0 Maximum value: 2,147,483,647

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Example Request

None

Example Response

Status code: 200

Request successful.

{
  "chain" : 1,
  "node" : 2,
  "full_node" : 1,
  "staking" : 1,
  "call" : 10000,
  "alarm" : 10
}

Status code: 400

Request failed.

{
  "code" : 400,
  "error_code" : "BCS.03400001",
  "error_msg" : "Invalid request.",
  "message" : "unmarshal request data error"
}

Status code: 401

Authentication failed.

{
  "code" : 401,
  "error_code" : "BCS.03401001",
  "error_msg" : "Authorization failed.",
  "message" : "request token is not valid"
}

Status code: 500

Internal service error.

{
  "code" : 500,
  "error_code" : "BCS.03500001",
  "error_msg" : "Internal error.",
  "message" : "project [xxx] node [xxx] get service bearer user token error"
}