コンテンツにスキップ

変更¶

POST /api/v1/log_backup_cfg/{cfg_uuid}/modify

概要¶

個別のデータ転送ルールを変更します。

ルートパラメータ¶

パラメータ名	タイプ	必須	説明
cfg_uuid	string	Y	設定 UUID

Body リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
extend	json		フロントエンドのカスタムデータ空を許可: True
syncExtensionField	boolean		拡張フィールドのバックアップを同期するかどうか。true は同期、false は同期しない。デフォルトは同期しない空を許可: False
openPermissionSet	boolean		カスタム権限設定を有効にするかどうか（デフォルト false：無効）。有効にすると、転送ルールのデータを読み取る権限は readPermissionSet に従う（2025-03-26 リリースで追加）空を許可: False
readPermissionSet	array		データ転送ルールのデータを読み取る権限設定。ロール（所有者以外）を設定可能（2025-03-26 リリースで追加）例: ['wsAdmin', 'general'] 空を許可: False
storageClass	string		ストレージタイプ空を許可: False 空文字列を許可: True
storageFormat	string		ストレージ形式。デフォルト値は json 空を許可: False 空文字列を許可: True 選択可能な値: ['json', 'parquet']
dataType	string		データタイプ。旧クライアントが現在の値を返す場合のみ対応。ルール作成後は変更不可空を許可: False 選択可能な値: ['llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am']
accessCfg	json		外部リソースアクセス設定情報空を許可: False
accessCfg.provider	string		プロバイダー空を許可: False 選択可能な値: ['aliyun', 'aws', 'huawei', 'volcengine', 'google']
accessCfg.grantType	string		認可タイプ空を許可: False 選択可能な値: ['role', 'ram', 'account', 'serviceAccount']
accessCfg.cloudAccountId	string		クラウドアカウント ID 空を許可: False
accessCfg.bucket	string		ストレージバケット空を許可: False
accessCfg.externalId	string		外部一意識別 ID（AWS のロール認可方式における外部一意識別 ID）空を許可: False
accessCfg.role	string		ロール名空を許可: False
accessCfg.ak	string		アクセスキー ID 空を許可: False
accessCfg.sk	string		シークレットキー空を許可: False
accessCfg.serviceAccountJson	json		GCP サービスアカウントの JSON オブジェクト空を許可: False
accessCfg.topic	string		topic 空を許可: False 空文字列を許可: True
accessCfg.url	string		接続 URL（kafka に適用）空を許可: False
accessCfg.securityProtocol	string		セキュリティプロトコル（kafka に適用）空を許可: False 選択可能な値: ['plaintext', 'sasl_plaintext', 'sasl_ssl']
accessCfg.ca	string		クライアント SSL 証明書の内容空を許可: False 空文字列を許可: True
accessCfg.mechanism	string		認証方式空を許可: False 空文字列を許可: True 選択可能な値: ['plain', 'scram-sha-256', 'scram-sha-512']
accessCfg.username	string		ユーザー名空を許可: False 空文字列を許可: True
accessCfg.password	string		パスワード空を許可: False 空文字列を許可: True
accessCfg.endpoints	string		Apache Doris FE の HTTP/HTTPS アドレス。複数指定する場合は英語のカンマで区切る空を許可: False
accessCfg.database	string		Apache Doris データベース名空を許可: False
accessCfg.table	string		Apache Doris テーブル名。^[A-Za-z][A-Za-z0-9_]{0,63}$ に一致する必要がある空を許可: False
accessCfg.replicationNum	integer		Apache Doris で新規作成するテーブルのレプリカ数。省略または 0 を指定した場合はクラスターのデフォルト値を使用空を許可: False $minValue: 0
accessCfg.region	string		リージョン（任意。指定しない場合、現在のサイトに対応するベンダーのリージョンがデフォルトで使用される）空を許可: False
accessCfg.endpoint	string		アクセスアドレス。storeType が s3/obs/oss/tos かつ grantType=ram の場合に任意指定可能空を許可: False
accessCfg.bucketPath	string		ストレージバケットのパス空を許可: False 空文字列を許可: True
accessCfg.dataWaitSeconds	integer		オブジェクトストレージデータの待機時間（秒）。未指定の場合は既存の値を使用し、既存の値がない場合はデフォルトで 3600 空を許可: False 選択可能な値: [900, 1800, 3600]
accessCfg.isEncrypt	boolean		転送するデータを暗号化するかどうか。デフォルトは false（暗号化しない）空を許可: False

パラメータ補足説明¶

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/log_backup_cfg/lgbp_xxxx32/modify' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"extend":{"filters":[],"filterLogic":"and","indexs":["default"]},"syncExtensionField":true,"accessCfg":{"grantType":"ram","bucket":"test-s3-001","region":"cn-south-1","provider":"aws","endpoint":"https://s3.custom-endpoint.example.com"}}' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "conditions": "{}",
        "createAt": 1697613651,
        "creator": "xxx",
        "dataType": "logging",
        "deleteAt": -1,
        "extend": {
            "filterLogic": "and",
            "filters": [],
            "indexs": [
                "default"
            ]
        },
        "externalResourceAccessCfgUUID": "erac_xxxx32",
        "id": 686,
        "name": "temp_test",
        "status": 0,
        "storeType": "obs",
        "syncExtensionField": true,
        "taskErrorCode": "",
        "taskStatusCode": -1,
        "updateAt": 1697613856.5497322,
        "updator": "wsak_xxxxx",
        "uuid": "lgbp_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-599A0794-3DD7-4731-BA2F-0A3655C09684"
}