Help Center/ MetaStudio/ API Reference/ Tenant Management/ Signing Cloud Service Statement

Updated on 2025-12-08 GMT+08:00

View PDF

Signing Cloud Service Statement

Function

Signs the cloud service statement. Before calling this API, you should read and understand the Metastudio Privacy Agreement.

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

POST /v1/{project_id}/tenants/service-agreements/signed

**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.

Request Parameters

**Table 2** 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 3** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 4** Response body parameters
Parameter	Type	Description
current_version	String	Current service agreement version
need_to_sign	Boolean	Whether to sign the agreement. Default value: true
signed_version	String	Version of the signed service agreement
signed_time	String	Agreement signing time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
resign_deadline	String	Deadline for signing. The format complies with RFC 3339, for example, 2024-10-10T15:59:59Z.
resign_expire_process_mode	String	Method to take when an agreement expires. EXPIRE_AUTO_AGREE: automatically signed; EXPIRE_STOP_SERVICE: force signed.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

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

POST https://{endpoint}/v1/{projectId}/tenants/service-agreements/signed

Example Responses

Status code: 200

The cloud service statement has been signed.

{
  "current_version" : "V20230512",
  "need_to_sign" : true,
  "signed_version" : "V20230512",
  "signed_time" : "202-05-20T08:43:17Z"
}

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

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	The cloud service statement has been signed.
400	Parameters error, including the error code and its description.
401	Authentication is not performed or fails.
403	Not authorized.
500	Internal service error.