doc-exports/docs/smn/api-ref/smn_api_51002.html
guoyanyan feae604f17 SMN API 20220929 v1
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2022-11-10 09:15:21 +00:00

8.4 KiB

Modifying a Topic

Description

  • API name

    UpdateTopic

  • Function

    Update the topic display name.

URI

  • URI format

    PUT /v2/{project_id}/notifications/topics/{topic_urn}

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID

    See Obtaining a Project ID.

    topic_urn

    Yes

    String

    Unique resource ID of a topic. You can obtain it according to Querying Topics.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    display_name

    No

    String

    Topic display name, which is presented as the name of the email sender in email messages

    The display name cannot exceed 192 bytes.

  • Request example
    PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2
    { 
        "display_name":"testtest222"
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    request_id

    String

    Request ID, which is unique

  • Response example
    {
        "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085"
    }

Returned Value

See section Returned Value.

Error Code

See section Error Code.