コンテンツにスキップ

デフォルト設定ステータスの変更



POST /api/v1/account/status/modify

概要

現在の呼び出し元アイデンティティのオンコールステータスの変更をリクエストします。現在の標準 API Key エントリにはアイデンティティマッピングの制限があります。

呼び出し前と使用手順

このパスは現在の呼び出し元アイデンティティのオンコール/休暇ステータスに使用するもので、ワークスペースメンバー管理やアカウントの有効化/停止ではありません。他のアカウントを指定できる accountUUID パラメータはありません。

現在の標準 DF-API-KEY 呼び出しにはアイデンティティマッピングの制限があります。通常のワークスペース Key と個人 Key の現在のアクターはいずれも Key UUID ですが、ステータスを処理する業務クエリはアカウント UUID で読み取ります。そのため、通常の Key は通常のアカウントにヒットできず、通常は 500 を返します。working/mute の切り替え、ロール権限の引き上げ、ワークスペース Key から個人 Key への変更では解決できません。本ページでは互換性調査のために公開パスと宣言を保持しており、偽造された 200 の成功例は提供しません。コンソールの個人アカウント機能を使用するか、サーバー側でこのエントリを修正してから自動切り替えを組み込んでください。

リクエストフィールドでは accountStatus のみを宣言しており、アカウント UUID を追加で送信したり、認証ヘッダーを置き換えてこの制限を回避したりすることはできません。エラー時は traceId を記録して管理者に連絡し、自動ループでの再試行を避けてください。Front アカウントのログイン状態インターフェースは異なるアイデンティティチェーンを使用しており、その成功動作はこの OpenAPI Key エントリが使用可能であることを意味しません。過去のカスタムデータや内部からの直接呼び出しも、通常の成功契約として扱うことはできません。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
accountStatus string Y 必須文字列。空文字列を許可し、列挙型/長さの制限は宣言されていません。ただし、空値/任意の文字列で現在の Key 呼び出しが成功するわけではありません。この値はアカウントの有効化/停止 status でもありません。
空文字列を許可: True
null を許可: False
例: working
取得または入力方法: オンコール中は working、休暇中は mute を使用します。現在の Key のアイデンティティ制限は値とは無関係です。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/account/status/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"accountStatus":"working"}'

レスポンス

現在の標準 API Key リクエストは通常、HTTP 500 と下記のエラー JSON を返します。本ページでは、正常な Key で取得できる 200 のアカウント詳細を確認していません。接続前にアイデンティティマッピングの制限を解決する必要があります。

フィールド 型 説明
code integer 現在のアイデンティティマッピング失敗では通常 500 です。パラメータ/認証エラーは実際の HTTP とレスポンスエンベロープに従って返されます。
content object 本ページの 500 例では空オブジェクト {} であり、アカウント詳細ではありません。
errorCode string この問題では通常 ft.InternalServerError です。その他の認証/パラメータエラーはエラーテーブルと共通説明を参照してください。
message string 呼び出し元向けのエラーテキストで、リクエストの言語に応じて表示される場合があります。
success boolean 現在のエラーでは false です。HTTP 接続の成功だけで判断しないでください。
traceId string 調査用の関連 ID です。フィードバック時に提供してください。
{
  "code": 500,
  "content": {},
  "errorCode": "ft.InternalServerError",
  "message": "内部错误",
  "success": false,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

本ページでは、現在の標準 OpenAPI 呼び出しで観測できる失敗構造を示します。Front のログイン状態や内部でアカウント UUID を直接渡した場合の成功応答を、このパスの成功例として偽装していません。過去の異常なアカウント/Key データは個別に検証する必要があります。

HTTP ステータス errorCode 発生条件 メッセージまたは応答の説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドが欠落している、またはフィールド値が宣言された検証条件に違反している パラメータ解析失敗 パラメータの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON 形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError リクエスト JSON のトップレベルがオブジェクトではない 一部の JSON ファイル形式エラー accountStatus を含む JSON オブジェクトを送信してください。
500 ft.InternalServerError 正常な API Key のアクターが通常のアカウントにヒットせず、空のオブジェクトを直接更新する。またはその他の未処理のストレージエラー 内部エラー 現在のエントリはオンコールステータスの自動切り替えには使用できません。管理者に連絡してアイデンティティマッピングを処理し、traceId を保持して、盲目的な再試行を停止してください。

フィードバック

このページは役に立ちましたか?