From 2c93cf66d718347ab72bdc79b5a680927a255fe8 Mon Sep 17 00:00:00 2001 From: "Ru, Li Yi" Date: Wed, 6 Mar 2024 09:49:14 +0000 Subject: [PATCH] gaussdbmysql_api Reviewed-by: Drobnak, David Co-authored-by: Ru, Li Yi Co-committed-by: Ru, Li Yi --- docs/gaussdb_mysql/api-ref/ALL_META.TXT.json | 2 +- docs/gaussdb_mysql/api-ref/CLASS.TXT.json | 2 +- docs/gaussdb_mysql/api-ref/changeHistory.html | 8 +- .../api-ref/gaussdb_04_0012.html | 154 +++++++------- .../api-ref/gaussdb_04_0013.html | 190 +++++++++--------- 5 files changed, 183 insertions(+), 173 deletions(-) diff --git a/docs/gaussdb_mysql/api-ref/ALL_META.TXT.json b/docs/gaussdb_mysql/api-ref/ALL_META.TXT.json index 2f050c92e..57d139c8c 100644 --- a/docs/gaussdb_mysql/api-ref/ALL_META.TXT.json +++ b/docs/gaussdb_mysql/api-ref/ALL_META.TXT.json @@ -784,7 +784,7 @@ "node_id":"gaussdb_04_0013.xml", "product_code":"gaussdb", "code":"38", - "des":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3", + "des":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate it.Obtain the required region and endpoint.Before ", "doc_type":"api", "kw":"Modifying Resource Quotas,Quota Management,API Reference", "search_title":"", diff --git a/docs/gaussdb_mysql/api-ref/CLASS.TXT.json b/docs/gaussdb_mysql/api-ref/CLASS.TXT.json index cc297f3e2..8ece462d9 100644 --- a/docs/gaussdb_mysql/api-ref/CLASS.TXT.json +++ b/docs/gaussdb_mysql/api-ref/CLASS.TXT.json @@ -333,7 +333,7 @@ "code":"37" }, { - "desc":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate it.Obtain the required region and endpoint.PUT /v3", + "desc":"This API is used to modify the resource quota of a specified enterprise project.Learn how to authorize and authenticate it.Obtain the required region and endpoint.Before ", "product_code":"gaussdb", "title":"Modifying Resource Quotas", "uri":"gaussdb_04_0013.html", diff --git a/docs/gaussdb_mysql/api-ref/changeHistory.html b/docs/gaussdb_mysql/api-ref/changeHistory.html index dc9dbad71..4d6d6b367 100644 --- a/docs/gaussdb_mysql/api-ref/changeHistory.html +++ b/docs/gaussdb_mysql/api-ref/changeHistory.html @@ -8,7 +8,13 @@ -

2023-10-25

+

2024-02-28

+ +

Modified the following content:

+

Added precautions in Configuring Resource Quotas and Modifying Resource Quotas.

+ + +

2023-10-25

Modified the following content:

Modified the response parameters and examples in Deleting a Manual Backup.

diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0012.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0012.html index 4746b8dad..4d8396002 100644 --- a/docs/gaussdb_mysql/api-ref/gaussdb_04_0012.html +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0012.html @@ -4,25 +4,27 @@

Function

This API is used to configure resource quotas for a specified enterprise project. Before using this API:

+

Precautions

Before using this API, ensure that the enterprise project has been enabled and you have the gaussdb:quota:modify permission.

+

URI

POST /v3/{project_id}/quotas

-
Table 1 URI parameters

Parameter

+
- - - - - - - @@ -31,114 +33,114 @@

Request Parameters

-
Table 1 URI parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID of a tenant in a region.

+

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.
Table 2 Request header parameters

Parameter

+
- - - - - - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

+

User token.

X-Language

+

X-Language

No

+

No

String

+

String

Language.

+

Language.
-
Table 3 Request body parameters

Parameter

+
- - - - - - -
Table 3 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

quota_list

+

quota_list

Yes

+

Yes

Array of setQuota objects

+

Array of setQuota objects

Quota details. Up to 10 quota records can be configured at a time.

+

Quota details. Up to 10 quota records can be configured at a time.
-
Table 4 setQuota

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - @@ -147,66 +149,66 @@

Response Parameters

Status code: 201

-
Table 4 setQuota

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

enterprise_project_id

+

enterprise_project_id

Yes

+

Yes

String

+

String

Enterprise project ID.

+

Enterprise project ID.

enterprise_project_name

+

enterprise_project_name

Yes

+

Yes

String

+

String

Enterprise project name.

+

Enterprise project name.

instance_quota

+

instance_quota

Yes

+

Yes

Integer

+

Integer

Quota of the DB instance quantity. Value: 0 to 100000. (If there are already DB instances created, this parameter value must be greater than the number of existing instances.)

+

Quota of the DB instance quantity. Value: 0 to 100000. (If there are already DB instances created, this parameter value must be greater than the number of existing instances.)

vcpus_quota

+

vcpus_quota

Yes

+

Yes

Integer

+

Integer

Quota of vCPUs. Value: 0 to 2147483646. (If there are already DB instances created, this parameter value must be greater than the number of used vCPUs.)

+

Quota of vCPUs. Value: 0 to 2147483646. (If there are already DB instances created, this parameter value must be greater than the number of used vCPUs.)

ram_quota

+

ram_quota

Yes

+

Yes

Integer

+

Integer

Memory quota in GB. Value: 0 to 2147483646. (If there are already DB instances created, this parameter value must be greater than the used memory size.)

+

Memory quota in GB. Value: 0 to 2147483646. (If there are already DB instances created, this parameter value must be greater than the used memory size.)
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

quota_list

+

quota_list

Array of setQuota objects

+

Array of setQuota objects

Configured quota information.

+

Configured quota information.
-
Table 6 setQuota

Parameter

+
- - - - - - - - - - - - - - - - - diff --git a/docs/gaussdb_mysql/api-ref/gaussdb_04_0013.html b/docs/gaussdb_mysql/api-ref/gaussdb_04_0013.html index 2ba6c1182..2093b2f62 100644 --- a/docs/gaussdb_mysql/api-ref/gaussdb_04_0013.html +++ b/docs/gaussdb_mysql/api-ref/gaussdb_04_0013.html @@ -4,25 +4,27 @@

Function

This API is used to modify the resource quota of a specified enterprise project.

+

Precautions

Before using this API, ensure that the enterprise project has been enabled and you have the gaussdb:quota:modify permission.

+

URI

PUT /v3/{project_id}/quotas

-
Table 6 setQuota

Parameter

Type

+

Type

Description

+

Description

enterprise_project_id

+

enterprise_project_id

String

+

String

Enterprise project ID.

+

Enterprise project ID.

enterprise_project_name

+

enterprise_project_name

String

+

String

Enterprise project name.

+

Enterprise project name.

instance_quota

+

instance_quota

Integer

+

Integer

Quota of the DB instance quantity.

+

Quota of the DB instance quantity.

vcpus_quota

+

vcpus_quota

Integer

+

Integer

Quota of vCPUs.

+

Quota of vCPUs.

ram_quota

+

ram_quota

Integer

+

Integer

Memory quota in GB.

+

Memory quota in GB.
Table 1 URI parameters

Parameter

+
- - - - - - - @@ -31,114 +33,114 @@

Request Parameters

-
Table 1 URI parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID of a tenant in a region.

+

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.
Table 2 Request header parameters

Parameter

+
- - - - - - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

+

User token.

X-Language

+

X-Language

No

+

No

String

+

String

Language.

+

Language.
-
Table 3 Request body parameters

Parameter

+
- - - - - - -
Table 3 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

quota_list

+

quota_list

Yes

+

Yes

Array of setQuota objects

+

Array of setQuota objects

Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time.

+

Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time.
-
Table 4 setQuota

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - @@ -147,66 +149,66 @@

Response Parameters

Status code: 200

-
Table 4 setQuota

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

enterprise_project_id

+

enterprise_project_id

Yes

+

Yes

String

+

String

Enterprise project ID.

+

Enterprise project ID.

enterprise_project_name

+

enterprise_project_name

Yes

+

Yes

String

+

String

Enterprise project name.

+

Enterprise project name.

instance_quota

+

instance_quota

Yes

+

Yes

Integer

+

Integer

Quota of the DB instance quantity. Value: 0 to 100000. (If there are already instances created, this parameter value must be greater than the number of existing instances.)

+

Quota of the DB instance quantity. Value: 0 to 100000. (If there are already instances created, this parameter value must be greater than the number of existing instances.)

vcpus_quota

+

vcpus_quota

Yes

+

Yes

Integer

+

Integer

Quota of vCPUs. Value: 0 to 2147483646. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.)

+

Quota of vCPUs. Value: 0 to 2147483646. (If there are already instances created, this parameter value must be greater than the number of used vCPUs.)

ram_quota

+

ram_quota

Yes

+

Yes

Integer

+

Integer

Memory quota in GB. Value: 0 to 2147483646. (If there are already instances created, this parameter value must be greater than the used memory size.)

+

Memory quota in GB. Value: 0 to 2147483646. (If there are already instances created, this parameter value must be greater than the used memory size.)
Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

quota_list

+

quota_list

Array of setQuota objects

+

Array of setQuota objects

Configured quota information.

+

Configured quota information.
-
Table 6 setQuota

Parameter

+
- - - - - - - - - - - - - - - - - @@ -214,26 +216,26 @@

Status code: 400

-
Table 6 setQuota

Parameter

Type

+

Type

Description

+

Description

enterprise_project_id

+

enterprise_project_id

String

+

String

Enterprise project ID.

+

Enterprise project ID.

enterprise_project_name

+

enterprise_project_name

String

+

String

Enterprise project name.

+

Enterprise project name.

instance_quota

+

instance_quota

Integer

+

Integer

Quota of the DB instance quantity.

+

Quota of the DB instance quantity.

vcpus_quota

+

vcpus_quota

Integer

+

Integer

Quota of vCPUs.

+

Quota of vCPUs.

ram_quota

+

ram_quota

Integer

+

Integer

Memory quota in GB.

+

Memory quota in GB.
Table 7 Response body parameters

Parameter

+
- - - - - - - - @@ -241,26 +243,26 @@

Status code: 500

-
Table 7 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.
Table 8 Response body parameters

Parameter

+
- - - - - - - -
Table 8 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.