Update Span Sampling Policy

Update Span Sampling Policy

Update a specific span sampling policy

Request
URI
PUT
https://{api_host}/api/v2/spansamplingpolicy/{id}
COPY
Path Parameters
string
id
Required

id


Request Body
SpanSamplingPolicy of type(s) application/json
Optional
{
    "name": "string",
    "id": "string",
    "active": false,
    "description": "string",
    "expression": "string",
    "createdEpochMillis": 0,
    "updatedEpochMillis": 0,
    "samplingPercent": 0,
    "deleted": false,
    "creatorId": "string",
    "updaterId": "string"
}
string
name
Required

Span sampling policy name

string
id
Required

Unique identifier of the span sampling policy

boolean
active
Optional

Whether span sampling policy is active

string
description
Optional

Span sampling policy description

string
expression
Required

Span sampling policy expression

integer As int64 As int64
createdEpochMillis
Optional

Created time of the span sampling policy

integer As int64 As int64
updatedEpochMillis
Optional

Last updated time of the span sampling policy

integer As int32 As int32
samplingPercent
Optional

Sampling percent of policy, 100 means keeping all the spans that matches the policy

boolean
deleted
Optional

Whether span sampling policy is soft-deleted, can be modified with delete/undelete api

string
creatorId
Optional

Creator user of the span sampling policy

string
updaterId
Optional

Updater user of the span sampling policy

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerSpanSamplingPolicy of type(s) application/json
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "name": "string",
        "id": "string",
        "active": false,
        "description": "string",
        "expression": "string",
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "samplingPercent": 0,
        "deleted": false,
        "creatorId": "string",
        "updaterId": "string"
    }
}
status
Required

status

response
Optional

response