Updating a Topic

Function

This API is used to update the topic display name.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID.
topic_urn	Yes	String	Specifies the resource identifier of the topic, which is unique. To obtain the resource identifier, see Querying Topics.

Request Parameters

Table 2 Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters
Parameter	Mandatory	Type	Description
display_name	Yes	String	Specifies the topic display name, which is presented as the name of the email sender in email messages. The display name cannot exceed 192 bytes.

Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.

Status code: 400

Table 5 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 403

Table 6 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 404

Table 7 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 500

Table 8 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Example Requests

Modifying the display name of the topic named test_topic_v2 to testtest222

PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2

{
  "display_name" : "testtest222"
}

Example Responses

Status code: 200

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085"
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
403	Unauthorized
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Topics

Предыдущая статья

Querying Details About a Topic

Следующая статья

Deleting a Topic

Была ли эта статья полезна?

Поддержка Юридические документы