Red Hat Summit7.6. globalmessages
メッセージ API。
7.6.1. createGlobalMessage
メッセージを作成します。
POST /api/v1/messages
認可: oauth2_implicit(super:user)
要求の body スキーマ (application/json)
新規メッセージの作成
| 名前 | 説明 | スキーマ |
|---|---|---|
|
message | 単一メッセージ | object |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成に成功 | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
$ curl -X POST "https://<quay-server.example.com>/api/v1/messages" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"message": {
"content": "Hi",
"media_type": "text/plain",
"severity": "info"
}
}'7.6.2. getGlobalMessages
スーパーユーザーのメッセージを返します。
GET /api/v1/messages
認可:
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
$ curl -X GET "https://<quay-server.example.com>/api/v1/messages" \
-H "Authorization: Bearer <access_token>"7.6.3. deleteGlobalMessage
メッセージを削除します。
DELETE /api/v1/message/{uuid}
認可: oauth2_implicit(super:user)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
uuid | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 204 | 削除済み | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/message/<uuid>" \
-H "Authorization: Bearer <access_token>"