Method: organizations.consumers.status

Checks the status of this service.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*}/consumers/status

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the Apigee organization. Use the following structure in your  request: organizations/{org}

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "status": string,
  "message": string,
  "requestId": string,
  "errorCode": string,
  "data": {
    object (CapiServerStatus)
  }
}
Fields
status

string

Status of the operation.

message

string

Description of the operation.

requestId

string

ID that can be used to find request details in the log files.

errorCode

string

ID that can be used to find errors in the log files.

data

object (CapiServerStatus)

Status of the server.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

CapiServerStatus

JSON representation
{
  "ok": boolean
}
Fields
ok

boolean

Boolean flag that specifies whether the server status is OK.