Query release summary

Query the number of data releases in the current workspace and the number of target workspaces.

HTTP
GET $CLOUDSIGMA_API_BASE/data-share/publishes/summary

Before you call this API

Configure the regional API endpoint and authentication, and select the target workspace.

Request

Shell
curl "$CLOUDSIGMA_API_BASE/data-share/publishes/summary" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Successful response

Returns 200 and the summary quantity on success.

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 3,
    "target_total": 5
  }
}

The response fields are as follows.

Field

Type

Description

data.total

integer

The number of data releases in the current workspace.

data.target_total

integer

The number of target workspaces associated with all publications.

Error response

JSON
{
  "code": "ErrServer",
  "msg": "服务器内部错误",
  "data": null
}

Common HTTP errors

HTTP status code

error code

Common causes

Recommended actions

403

ErrPermissionDenied

The current identity does not have permission to read the publication.

Use credentials with read permissions.

503

ErrServer

Dependent services are temporarily unavailable.

Try again later.

500

ErrServer

The server failed to read the publication summary.

Try again later.

Last updated on