素材ステータスの同期

POST/api/v1/materials/sync

認証方式

Authorization: Bearer <API_KEY>。

リクエストボディ · application/json

フィールドは不要で、空のオブジェクト {} を送信できます。

リクエスト例

curl -X POST "$LOCOPAL_BASE_URL/api/v1/materials/sync" \
  -H "Authorization: Bearer $LOCOPAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

レスポンスパラメータ

パラメータ	型	説明
`code`	integer	成功時は `0`
`msg`	string	成功時は `素材状态已同步`
`data.groups`	integer	今回更新されたグループ数
`data.adopted_groups`	integer	今回現在のアカウントへの所属が確認されたグループ数
`data.assets`	integer	今回更新された素材数
`data.removed_assets`	integer	無効が確認され削除された素材数

レスポンスボディ

{
  "code": 0,
  "data": {
    "groups": 2,
    "adopted_groups": 0,
    "assets": 3,
    "removed_assets": 0
  },
  "msg": "素材状态已同步"
}

同期では現在のアカウント自身のグループごとに素材を 1 件ずつ読み取り、名前、ステータス、エラー情報、素材アドレスを更新します。1 回の照会でレコードが返されなかっただけでは素材は削除されず、別途再度照会して存在しないことが確認された場合にのみ削除されます。そのため、同期を繰り返し実行しても安全です。

エラーレスポンス

HTTP	msg	説明
`401`	`Invalid token`	API キーが欠落、誤り、または失効しています
`502` / `503`	`素材服务暂不可用`	素材サービスに異常があります。リクエスト情報を保持してから再試行してください

このページの目次