Skip to content

Query OSS Output Config List ​

API Information ​

  • Request Path: /market/ossOutput/list
  • Request Method: POST
  • Content-Type: application/json

Request Headers ​

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure ​

FieldTypeRequiredDescriptionConstraints
pageNumberIntegerNoPage numberDefault from server when omitted
pageSizeIntegerNoPage sizeDefault from server when omitted

Request Body Example ​

json
{
  "pageNumber": 1,
  "pageSize": 10
}

Response Body Structure ​

CommonResponse Object ​

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataOssOutputListRespResponse data

OssOutputListResp Object ​

FieldTypeDescription
totalLongTotal count
contentList<OssOutputListItemResp>Config list

OssOutputListItemResp Object ​

FieldTypeDescription
idLongConfig ID
nameStringConfig name
endPointStringEndpoint
accessPathStringAccess path
ctimeLongCreate timestamp
mtimeLongModify timestamp

Response Examples ​

Success Response ​

json
{
  "code": 200,
  "message": "success",
  "data": {
    "total": 1,
    "content": [
      {
        "id": 2001,
        "name": "default-output",
        "storageType": "S3",
        "endPoint": "https://s3.example.com",
        "bucket": "eo-result",
        "folderPath": "/market/orders",
        "accessPath": "https://s3.example.com/eo-result/market/orders",
        "accessRelativePath": "/eo-result/market/orders",
        "ctime": 1775728800,
        "mtime": 1775728800
      }
    ]
  }
}

Failure Response ​

json
{
  "code": 400,
  "message": "Invalid parameters",
  "data": null
}

Error Code Description ​

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions ​

  1. This API is used to query current user's output storage configurations.
  2. User authentication is required.
  3. Supports pagination parameters.

Notes ​

  • Sensitive keys are not returned in this API.