Help Center/ MetaStudio/ API Reference/ Tenant Management/ Querying Tenant Personalized Notifications
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Tenant Personalized Notifications

Function

Queries personalized notifications for a tenant.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/tenants/notice-configurations

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of items displayed on each page.

Value range:

1~100

Default value:

10

offset

No

Integer

Offset where the query starts.

Value range:

0~2147483647

Default value:

0

type

Yes

String

Notification type.

  • RESOURCE_EXPIRE: notifications about resource expiration

  • RESOURCE_LEFT: notifications about remaining resources

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

The format is YYYYMMDD'T'HHMMSS'Z'.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 5 Response body parameters

Parameter

Type

Description

type

String

Notification type.

  • RESOURCE_EXPIRE: notifications about resource expiration

  • RESOURCE_LEFT: notifications about remaining resources

send_msg

Boolean

Whether to send SMS notifications.

Default value:

false

properties

String

Notification configuration item

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://{endpoint}/v1/{projectId}/tenants/notice-configurations

Example Responses

Status code: 401

Authentication is not performed or fails.

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 403

Not authorized.

{
  "error_code" : "MSS.00000005",
  "error_msg" : "Forbidden"
}

Status code: 500

Internal service error.

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code

Description

200

Notification configuration query result.

401

Authentication is not performed or fails.

403

Not authorized.

500

Internal service error.

Error Codes

See Error Codes.

Parent Topic: Tenant Management