Welcome to GaussDB(openGauss) API Reference. GaussDB(openGauss) is a next-generation, enterprise-class distributed database. It is designed based on the shared-nothing architecture and supports both x86 and Kunpeng CPU architectures. It features the following: high-throughput, strong-consistency transaction processing capabilities, financial-grade HA with 3DC geo-redundant DR, high scalability with a distributed architecture, and high-performance big data query capabilities. GaussDB(openGauss) is suitable for core systems used in a wide range of sectors, such as finance, telecom, and government.
-This document describes how to use application programming interfaces (APIs) to perform operations on DB instances, such as DB instance creation, deletion, query, parameter modifications, and scaling. For details about all supported operations, see API Overview.
+GaussDB is a distributed relational database. GaussDB supports distributed transactions and intra-city deployment across AZs for zero data loss, storage for petabytes of data, and scale-out to more than 1,000 nodes. It is highly available, secure, and scalable and provides services including quick deployment, backup, restoration, monitoring, and alarm reporting for enterprises.
+This document describes how to use application programming interfaces (APIs) to perform operations on instances, such as creating, deleting, querying and scaling out instances. For operation details, see API Overview.
API Calling
-GaussDB(openGauss) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Overview.
+GaussDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see API Overview.
Endpoints
-An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.
+An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.
Constraints
-- For more constraints, see API description.
For more constraints, see API description.
Concepts
-- Domain
A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The domain is a payment entity and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.
+- Domain
A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. To ensure account security, do not use the domain for routine management.
- IAM User
An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).
-The domain name, username, and password will be required for API authentication.
- - Region
A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
- - AZ
An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.
- - Project
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
-Figure 1 Project isolating model+
- User
A user is created using an account to use cloud services. Each user has its own identity credentials (password and access keys).
+The domain name, username, and password will be required for API authentication.
+ - Region
A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
+ - AZ
An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.
+ - Project
Projects group and isolate compute, storage, and network resources across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
+Figure 1 Project isolating model
- User
diff --git a/docs/opengauss/api-ref/opengauss_api_0007.html b/docs/opengauss/api-ref/opengauss_api_0007.html index 5ec1093c..e82bd93a 100644 --- a/docs/opengauss/api-ref/opengauss_api_0007.html +++ b/docs/opengauss/api-ref/opengauss_api_0007.html @@ -1,31 +1,51 @@ - +API Overview
-GaussDB(openGauss) APIs enable you to use all GaussDB(openGauss) functions, including creating/deleting DB instances and scaling up instance storage space.
+You can use APIs to create and delete DB instances, query DB instances, obtain and modify parameters of a specified DB instance, and set and query automated backup policies. For details, see the following table.
-Type
+Type
Subtype
+Subtype
Description
+Description
GaussDB(openGauss) APIs
+GaussDB APIs
DB Instance Management
+Instance Management
Manage DB instances, including creating a DB instance, scaling up instance storage space, delete a DB instance, obtaining a DB instance list, obtaining a specified DB instance, adding Coordinator Nodes (CNs), adding shards, resetting a database password, and change a DB instance name.
+Manage instances, including creating an instance, scaling up storage, deleting an instance, obtaining instances, obtaining a specified instance, adding CNs, adding shards, resetting a database password, and changing an instance name.
Parameter Configuration
+Parameter Configuration
Modify parameters of a specified DB instance.
+Obtain and modify parameters of a specified DB instance and obtain the parameter templates.
Backup Management
+Backup Management
Set an automated backup policy.
+Configure and query automated backup policies, query backups, and create and delete manual backups.
+DB Engine Versions and Specifications
+Query DB engine versions and query database specifications.
+Disk Type Queries
+Query database disk type.
+Task Management
+Obtain task information, query tasks, and delete a task record.
+Recycle Bin
+Set a recycling policy.
Calling APIs
+ +++ diff --git a/docs/opengauss/api-ref/opengauss_api_0009.html b/docs/opengauss/api-ref/opengauss_api_0009.html new file mode 100644 index 00000000..620dd81c --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0009.html @@ -0,0 +1,198 @@ + + +-
+
- Making an API Request
+
+ - Authentication
+
+ - Response
+
+
Making an API Request
++This section describes the structure of a REST API and how to call an API. Before calling an API, you need to obtain the user token. The obtained token can then be used to authenticate the calling of other APIs.
++Request URI
A request URI consists of the following:
+{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
+Although a request URI is included in a request header, most programming languages or frameworks require the request URI to be separately transmitted, rather than being conveyed in a request message.
+ ++
+Table 1 Parameters in a URI Parameter
+Description
+URI-scheme
+Protocol used to transmit requests. All APIs use HTTPS.
+Endpoint
+Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.
+resource-path
+Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.
+query-string
+Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.
++
To simplify the URI display, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
++Request Methods
The HTTP protocol defines the following request methods that can be used to send a request to the server. +++
+Table 2 HTTP methods Method
+Description
+GET
+Requests the server to return the specified resources.
+PUT
+Requests the server to update specified resources.
+POST
+Requests the server to add resources or perform special operations.
+DELETE
+Requests the server to delete specified resources, for example, an object.
+PATCH
+Requests the server to update part of a specified resource.
+If the resource does not exist, the PATCH method creates a resource.
+For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
+++1POST https://{{Endpoint}}/v3/auth/tokens +
+Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, add Content-Type that defines a request body type to request for the authentication information.
+Table 3 lists common request header fields. +++
+Table 3 Common request headers Name
+Description
+Mandatory
+Example Value
+Host
+Requested server information, which can be obtained from the URL of the service API. The value is in the hostname[:port] format. If the port number is not specified, the default port is used. The default port number for https is 443.
+No
+This parameter is mandatory for AK/SK authentication.
+code.test.com
+or
+code.test.com:443
+Content-Type
+MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.
+Yes
+application/json
+Content-Length
+Length of the request body. The unit is byte.
+No
+3495
+X-Project-Id
+Project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.
+No
+e9993fc787d94b6c886cbaa340f9c0f4
+X-Auth-Token
+User token.
+The user token is a response to the API used to obtain a user token. This API is the only one that does not require authentication.
+After the request is processed, the value of X-Subject-Token in the message header is the token value.
+No
+This parameter is mandatory for token authentication.
+The following is part of an example token:
+MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
+The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows.+++1 +2
POST https://{{Endpoint}}/v3/auth/tokens +Content-Type: application/json +
+(Optional) Request Body
This part is optional. A request body is generally sent in a structured format (for example, JSON or XML), corresponding to Content-Type in the request header, and is used to transfer content other than the request header. If the request body contains full-width characters, these characters must be coded in UTF-8.
+The request body varies according to the APIs. Certain APIs do not require the request body, such as the GET and DELETE APIs.
+In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with actual values. You can obtain the values from Regions and Endpoints.++ scope specifies where a token takes effect. In the example, the token takes effect only on the resources specified by the project ID. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.
++POST https://{{Endpoint}}/v3/auth/tokens +Content-Type: application/json + +{ + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "********", + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxxxxxxxxxxxx" + } + } + } +}+If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. For the API used to obtain a user token, x-subject-token in the response header is the desired user token. This token can then be used to authenticate the calling of other APIs.
+++ diff --git a/docs/opengauss/api-ref/opengauss_api_0010.html b/docs/opengauss/api-ref/opengauss_api_0010.html new file mode 100644 index 00000000..9b72f1bb --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0010.html @@ -0,0 +1,49 @@ + + +++Parent topic: Calling APIs+Authentication
++Token authentication must be performed to call APIs.
+Token-based authentication: Requests are authenticated using a token.
++Token Authentication
+ The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.
+A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.
+{ + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "********", + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxx" + } + } + } + } ++In Making an API Request, the process of calling the API used to obtain a user token is described.
+After a token is obtained, add the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
+++1 +2 +3
POST https://{{Endpoint}}/v3/auth/projects +Content-Type: application/json +X-Auth-Token: ABCDEFJ.... +
++ diff --git a/docs/opengauss/api-ref/opengauss_api_0011.html b/docs/opengauss/api-ref/opengauss_api_0011.html new file mode 100644 index 00000000..e4455e97 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_api_0011.html @@ -0,0 +1,40 @@ + + +++Parent topic: Calling APIs+Response
+++Status Code
After sending a request, you will receive a response, including the status code, response header, and response body.
+A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see Status Codes.
+For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
++Response Header
Similar to a request, a response also has a header, for example, Content-Type.
+Figure 1 shows the response header for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
+ ++(Optional) Response Body
This part is optional. The body of a response is often returned in structured format (for example, JSON or XML) as specified in the Content-Type header field. The response body transfers content except the response header.
+The following is part of the response body for the API used to obtain a user token.+{ + "token": { + "expires_at": "2019-02-13T06:52:13.855000Z", + "methods": [ + "password" + ], + "catalog": [ + { + "endpoints": [ + { + "region_id": "az-01", +......+If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.+{ + "error_code": "AS.0001", + "error_msg": "The format of message is error" +} ++In the response body, error_code is an error code, and error_msg provides information about the error.
+++ diff --git a/docs/opengauss/api-ref/opengauss_api_0012.html b/docs/opengauss/api-ref/opengauss_api_0012.html index 2174df77..e1adbcd2 100644 --- a/docs/opengauss/api-ref/opengauss_api_0012.html +++ b/docs/opengauss/api-ref/opengauss_api_0012.html @@ -1,9 +1,8 @@ - +++Parent topic: Calling APIs+Using APIs
-Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
-Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
-For details about how to use APIs, see API Usage Guidelines.
+- diff --git a/docs/opengauss/api-ref/opengauss_api_0013.html b/docs/opengauss/api-ref/opengauss_api_0013.html index 7c20724a..4a553e78 100644 --- a/docs/opengauss/api-ref/opengauss_api_0013.html +++ b/docs/opengauss/api-ref/opengauss_api_0013.html @@ -1,15 +1,23 @@ - + -Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
API
- +APIs (Recommended)
+diff --git a/docs/opengauss/api-ref/opengauss_api_0014.html b/docs/opengauss/api-ref/opengauss_api_0014.html index e1ba8ac7..a27c4e9a 100644 --- a/docs/opengauss/api-ref/opengauss_api_0014.html +++ b/docs/opengauss/api-ref/opengauss_api_0014.html @@ -1,29 +1,35 @@ - + -DB Instance Management
- +Instance Management
+diff --git a/docs/opengauss/api-ref/opengauss_api_0015.html b/docs/opengauss/api-ref/opengauss_api_0015.html index 10dd9b43..26304240 100644 --- a/docs/opengauss/api-ref/opengauss_api_0015.html +++ b/docs/opengauss/api-ref/opengauss_api_0015.html @@ -1,26 +1,26 @@ - +- Creating a DB Instance
- - Scaling Up Storage Space of a DB Instance
+ - Adding CNs, Adding Shards, or Scaling Up Storage
- Deleting a DB Instance
- - Querying Details About DB Instances
-
- - Adding CNs
-
- - Adding Shards
+ - Querying DB Instances
- Resetting a Database Password
- - Modifying a DB Instance Name
+ - Changing a DB Instance Name
+
+ - Rebooting a DB Instance
+
+ - Switching Roles of the Primary and Standby DNs in Shards
+
+ - Querying the Components of a DB Instance
+
+ - Changing vCPUs and Memory of a DB Instance
+
+ - Changing the Port Number of a Specified DB Instance
-Parent topic: API+Parent topic: APIs (Recommended)Creating a DB Instance
-Function
This API is used to create a GaussDB(openGauss) DB instance. GaussDB(openGauss) supports distributed instances.
-- Before calling an API, you need to understand the API in Using APIs.
- Before calling this API, obtain the required region and endpoint.
-Function
This API is used to create a GaussDB instance. Before calling this API:
+- Learn how to authenticate this API.
- Understand the API in Using APIs.
- Obtain the required region and endpoint.
URI
- URI format -
- Example
https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances
- - Parameter description
-
Table 1 Parameter description Name
+URI
- URI format +
- Example
https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances
+ - Parameter description
+
Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
-For details about how to obtain the project ID, see Obtaining a Project ID.
+Project ID of a tenant in a region.
+To obtain this value, see Obtaining a Project ID.
Request
-Table 2 Parameter description (for distributed instance creation) Name
+Request
+-Table 2 Parameter description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
name
+name
Yes
+Yes
String
+String
Specifies the DB instance name.
-DB instances of the same type can have same names under the same tenant.
-The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_).
+Instance name.
+Instances of the same type can have same names under the same tenant.
+The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).
datastore
+datastore
Yes
+Yes
Object
+Object
Specifies the database information.
-For details, see Table 3.
+Database information.
+For details, see Table 3.
ha
+ha
Yes
+Yes
Object
+Object
Used to create a distributed instance. For details, see Table 4.
+Instance deployment model. For details, see Table 4.
configuration_id
+configuration_id
No
+No
String
+String
Specifies the parameter template ID. If this parameter is not specified, the default parameter template is used.
+Parameter template ID. If this parameter is not specified, the default parameter template is used and this parameter is not returned in the response body.
port
+port
No
+No
String
+String
Specifies the database port.
-The GaussDB(openGauss) database port ranges from 1024 to 39998 (excluding the following which are occupied by the system and cannot be used: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 12016, 12017, 20049, 20050, 21731, 21732, 32122, 32123, and 32124).
-If this parameter is not specified, the default port 8000 is used.
+Port number used by the database to provide services for external systems, ranging from 1024 to 39998. It cannot be set to the default value 8000. The following ports are not allowed: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 12016, 12017, 20049, 20050, 21731, 21732, 32122, 32123, and 32124.
password
+password
Yes
+Yes
String
+String
Specifies the database password.
-The password cannot be empty and must contain 8 to 32 characters, including at least three of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#%^*-_=+?,).
-You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking.
+Database password.
+The password must:
+Consist of 8 to 32 characters, including at least three of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^&*()-_=+|[{}];:,<.>/?).
+Enter a strong password to improve security, preventing security risks such as brute force cracking.
backup_strategy
+backup_strategy
No
+No
Object
+Object
Specifies the backup policy.
-For details, see Table 5.
+Backup policy.
+For details, see Table 5.
flavor_ref
+disk_encryption_id
Yes
+No
String
+String
Specifies the specification code. The value cannot be empty. For details on how to obtain the GaussDB(openGauss) specification code, see Table 1.
+Key ID for disk encryption. The default value is empty.
volume
+flavor_ref
Yes
+Yes
Object
+String
Specifies the volume information.
-For details, see Table 6.
+Specification code. The value cannot be empty. For details on how to obtain the GaussDB specification code, see DB Instance Specifications.
region
+volume
Yes
+Yes
String
+Object
Specifies the region ID.
-The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.
+Volume information.
+For details, see Table 6.
availability_zone
+region
Yes
+Yes
String
+String
Specifies the AZ ID.
-The value cannot be empty. You can deploy GaussDB(openGauss) in the same AZ or across three different AZs, and use commas (,) to separate AZs. For example:
-- To deploy GaussDB(openGauss) in the same AZ, enter three same AZ IDs.
- To deploy GaussDB(openGauss) across three different AZs, enter three different AZ IDs.
The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.
+Region ID.
+The value cannot be left blank. For details about how to obtain this parameter value, see Regions and Endpoints.
vpc_id
+availability_zone
Yes
+Yes
String
+String
Specifies the VPC ID. To obtain this parameter value, use either of the following methods:
-- Method 1: Log in to VPC console and view the VPC ID in the VPC details.
- Method 2: See the "Querying VPCs" section in the Virtual Private Cloud API Reference.
AZ ID.
+The value cannot be left blank. You can deploy GaussDB in the same AZ or across three different AZs, and use commas (,) to separate AZs. For example:
+- To deploy a DB instance in the same AZ, enter three same AZ IDs.
- To deploy a DB instance across three different AZs, enter three different AZ IDs.
The value cannot be left blank. For details about how to obtain this parameter value, see Regions and Endpoints.
subnet_id
+vpc_id
Yes
+Yes
String
+String
Specifies the network ID. To obtain this parameter value, use either of the following methods:
-- Method 1: Log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
- Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in Virtual Private Cloud API Reference.
VPC ID. To obtain this parameter value, use the following methods:
+- Method 1: Log in to VPC console and view the VPC ID in the VPC details.
- Method 2: See the section "Querying VPCs" in the Virtual Private Cloud API Reference.
security_group_id
+subnet_id
No
+Yes
String
+String
Specifies the security group which the DB instance belongs to. To obtain this parameter value, use either of the following methods:
-- Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
- Method 2: See the "Querying Security Groups" section in the Virtual Private Cloud API Reference.
Network ID. To obtain this parameter value, use either of the following methods:
+- Method 1: Log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
- Method 2: See the section "Querying Subnets" in the Virtual Private Cloud API Reference.
- Method 2: See section "Querying Subnets" under "APIs" or "Querying Networks" under "OpenStack Neutron APIs" in Virtual Private Cloud API Reference.
charge_info
+security_group_id
No
+Yes
Object
+String
Specifies the billing type, which is only pay-per-use.
-For details, see Table 7.
+Security group which the instance is associated with. To obtain this parameter value, use either of the following methods:
+- Method 1: Log in to VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
- Method 2: See the section "Querying Security Groups" in the Virtual Private Cloud API Reference.
sharding_num
+charge_info
Yes
+No
Integer
+Object
Specifies the number of shards. The value ranges from 1 to 9.
+Billing type.
+For details, see Table 7.
coordinator_num
+time_zone
Yes
+No
Integer
+String
Specifies the number of CNs. The value ranges from 1 to 9. The number of CNs must be less than or equal to twice the number of shards.
+UTC time zone.
+- If this parameter is not specified, GaussDB uses UTC by default.
- If this parameter is specified, the value ranges from UTC-12:00 to UTC+12:00 at the full hour. For example, the parameter can be UTC+08:00 rather than UTC+08:30.
sharding_num
+No
+Integer
+This parameter is available only for distributed instances. Number of shards.
+coordinator_num
+No
+Integer
+This parameter is available only for distributed instances. Number of CNs. The number of CNs cannot exceed twice the number of shards.
+replica_num
+No
+Integer
+Number of replicas. The value can be 2 or 3 (default).
Table 3 datastore field data structure description Name
+-Table 3 datastore field data structure description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
type
+type
Yes
+Yes
String
+String
Specifies the DB engine. Value:
-GaussDB(openGauss).
+DB engine. Value:
+GaussDB. It is case-insensitive.
version
+version
Yes
+No
String
+String
Specifies the database version.
-The following versions are supported:
-- 1.1
- 1.2
DB engine version. If this parameter is not specified, the latest version is used by default.
+For details, see Querying DB Engine Versions.
Table 4 ha field data structure description Name
++ +
+Table 4 ha field data structure description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
mode
+mode
Yes
+Yes
String
+String
Specifies the distributed mode of GaussDB(openGauss). The value is enterprise and is case insensitive.
+Deployment model. Its value is enterprise for distributed instances and centralization_standard for primary/standby instances. It is case-insensitive.
replication_mode
+consistency
Yes
+Yes
String
+String
Specifies the replication mode for the standby node.
-Value:
-For GaussDB(openGauss), the value is sync.
-NOTE:- sync indicates the synchronous replication mode.
Transaction consistency type. The value can be strong or eventual and is case-insensitive.
+replication_mode
+Yes
+String
+Replication mode for the standby node.
+Value:
+sync
+NOTE:sync indicates synchronous replication.
consistency
+-Table 5 backup_strategy field data structure description Name
+Mandatory
+Type
+Description
+start_time
Yes
+Yes
String
+String
Specifies the instance consistency type. The value can be strong or eventual and is case-insensitive.
+Backup time window. The creation of an automated backup will be triggered during the backup time window.
+The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
+- The HH value must be 1 greater than the hh value.
- The values of mm and MM must be the same and must be set to 00.
Example value:
+- 08:00-09:00
- 23:00-00:00
keep_days
+No
+Integer
+Retention days for specific backup files.
+Value: 0 to 732. If this parameter is not specified or is set to 0, the default value 7 is used.
Table 5 backup_strategy field data structure description Name
+-Table 6 volume field data structure description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
start_time
+type
Yes
+Yes
String
+String
Specifies the backup time window. Automated backups will be triggered during the backup time window.
-The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
-- The HH value must be 1 greater than the hh value.
- The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45.
Example value:
-- 08:15-09:15
- 23:00-00:00
Disk type.
+The value can only be ULTRAHIGH (case-sensitive), indicating SSD.
keep_days
+size
No
+Yes
Integer
+Integer
Specifies the retention days for specific backup files.
-The value ranges from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled.
+Storage. For example, if this parameter is set to 40, 40 GB of storage is allocated to the created instance.
+ECS deployment: The value must be a multiple of (Number of shards x 40 GB), ranging from (Number of shards x 40 GB) to (Number of shards x 16 TB).
Table 6 volume field data structure description Name
+- -Table 7 chargeInfo field data structure description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
type
+charge_mode
Yes
+Yes
String
+String
Specifies the volume type.
-The value can only be ULTRAHIGH (case-sensitive), indicating SSD.
-size
-Yes
-Integer
-Specifies the volume size.
-The value must be a multiple of the number of shards multiplied by 40 GB, ranging from the number of shards multiplied by 40 GB to the number of shards multiplied by 16 TB.
+Billing mode. The value can only be postPaid.
-
+Table 7 chargeInfo field data structure description Name
-Mandatory
-Type
-Description
-charge_mode
-Yes
-String
-Specifies the billing mode. The value can only be postPaid, indicating the pay-per-use billing mode.
-- Example request
- Request example
Creating a DB instance of the enterprise edition: +
Creating an instance of the enterprise edition: { "name": "user1-v3-independent", "datastore": { - "type": "GaussDB(openGauss)", - "version": "1.1" + "type": "GaussDB", + "version": "1.4" }, - "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", + "flavor_ref": "gaussdb.opengauss.ee.dn.m4.2xlarge.8.in", "volume": { "type": "ULTRAHIGH", "size": 120 }, + "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "region": "eu-de", "availability_zone": "eu-de-01,eu-de-01,eu-de-01", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", @@ -412,343 +440,360 @@ "charge_info": { "charge_mode": "postPaid" }, - "password": "Gauss_234", + "password": "xxxxxx", "configuration_id": "b000d7c91f1749da87315700793a11d4pr14", "time_zone": "UTC+08:00", "ha":{ "mode":"enterprise", "consistency":"strong", - "replication_mode":"sync" + "replication_mode":"sync", + "consistency_protocol":"quorum" }, - "sharding_num":1, - "coordinator_num":1, - "port":8000 + "sharding_num": 1, + "coordinator_num": 1, + "replica_num": 3, + "port":8000, + "enable_force_switch":true }-Response
- Normal response
-
Table 8 Parameter description Name
+Response
- Normal response
+-
Table 8 Parameter description Name
Type
+Type
Description
+Description
instance
+instance
Object
+Object
Indicates the DB instance information.
-For details, see Table 9.
+Instance information.
+For details, see Table 9.
job_id
+job_id
String
+String
Indicates the ID of the DB instance creation task.
-This parameter is returned only for the creation of pay-per-use DB instances.
+Instance creation task ID.
Table 9 instance field data structure description Name
+-Table 9 instance description Name
Type
+Type
Description
+Description
id
+id
String
+String
Indicates the DB instance ID.
+Instance ID.
name
+name
String
+String
Indicates the DB instance name. DB instances of the same type can have same names under the same tenant.
-The value must be 4 to 64 characters in length and start with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_).
+Instance name. Instances of the same type can have same names under the same tenant.
+The value must consist of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_).
status
+status
String
+String
Indicates the DB instance status. For example, BUILD indicates that the DB instance is being created.
-Returned only for the creation of pay-per-use DB instances.
+Instance status. For example, BUILD indicates that the instance is being created.
datastore
+datastore
Object
+Object
Indicates the database information.
-For details, see Table 10.
+Database information.
+For details, see Table 10.
ha
+ha
Object
+Object
Returned when a distributed instance is created.
-For details, see Table 11.
+Database deployment model.
+For details, see Table 11.
port
+replica_num
String
+Integer
Indicates the database port, which is the same as the request parameter.
+Number of replicas.
backup_strategy
+port
Object
+String
Indicates the automated backup policy.
-For details, see Table 12.
+Database port, which is the same as the request parameter.
flavor_ref
+backup_strategy
String
+Object
Indicates the specification code. The value cannot be empty. For details on how to obtain the GaussDB(openGauss) specification code, see Table 1.
+Automated backup policy.
+For details, see Table 12.
volume
+flavor_ref
Object
+String
Indicates the volume information.
-For details, see Table 13.
+Specification code. The value cannot be empty. For details on how to obtain the GaussDB specification code, see DB Instance Specifications.
region
+volume
String
+Object
Indicates the region ID.
+Volume information.
+For details, see Table 13.
availability_zone
+region
String
+String
Indicates the AZ ID.
+Region ID.
vpc_id
+availability_zone
String
+String
Indicates the VPC ID.
+AZ ID.
subnet_id
+vpc_id
String
+String
Indicates the network ID of the subnet.
+VPC ID.
security_group_id
+subnet_id
String
+String
Indicates the security group to which the DB instance belongs.
+Network ID of the subnet.
charge_info
+security_group_id
Object
+String
Indicates the payment mode. Only pay-per-use is supported.
-For details, see Table 14.
+Security group to which the instance belongs.
+charge_info
+Object
+Payment mode.
+For details, see Table 14.
Table 10 datastore field data structure description Name
+-Table 10 datastore field data structure description Name
Type
+Type
Description
+Description
type
+type
String
+String
Indicates the DB engine. Value:
-GaussDB(openGauss)
+DB engine. Value:
+GaussDB
version
+version
String
+String
Indicates the database version.
+DB engine version.
Table 11 ha field data structure description Name
+-Table 11 ha field data structure description Name
Type
+Type
Description
+Description
mode
+mode
String
+String
Indicates the distributed model. The returned value is Enterprise. Currently, only the distributed model is supported.
+Distributed deployment. The value can be enterprise (Enterprise Edition). It is case-insensitive.
replication_mode
+replication_mode
String
+String
Indicates the replication mode for the standby node.
-Value:
-- For GaussDB(openGauss), the value is sync.
NOTE:- sync indicates the synchronous replication mode.
Replication mode for the standby node.
+Value:
+sync.
+NOTE:sync indicates synchronous replication.
consistency
+consistency
String
+String
Indicates the GaussDB(openGauss) reserved parameter, referring to the instance consistency type. The value can be strong or eventual.
+(GaussDB reserved parameter) Transaction consistency type. The value can be strong or eventual.
+consistency_protocol
+String
+Replica consistency protocol. Value: quorum (default value) or paxos
Table 12 backup_strategy field data structure description Name
+-Table 12 backup_strategy field data structure description Name
Type
+Type
Description
+Description
start_time
+start_time
String
+String
Indicates the backup time window. Automated backups will be triggered during the backup time window.
-The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
-- The HH value must be 1 greater than the hh value.
- The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45.
Example value:
-- 08:15-09:15
- 23:00-00:00
If backup_strategy in the request body is empty, 02:00-03:00 is returned for start_time by default.
+Backup time window. The creation of an automated backup will be triggered during the backup time window.
+The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
+- The HH value must be 1 greater than the hh value.
- The values of mm and MM must be the same and must be set to 00.
Example value:
+- 08:00-09:00
- 23:00-00:00
If backup_strategy in the request body is empty, 02:00-03:00 is returned for start_time by default.
keep_days
+keep_days
Integer
+Integer
Indicates the retention days for specific backup files.
-The value ranges from 0 to 732. If this parameter is not specified or set to 0, the automated backup policy is disabled.
-If backup_strategy in the request body is empty, 7 is returned for keep_days by default.
+Retention days for specific backup files.
+The value ranges from 1 to 732. If the backup_strategy field is not specified in the request body, keep_days in the response body is set to 7 days by default.
Table 13 volume field data structure description Name
+-Table 13 volume field data structure description Name
Type
+Type
Description
+Description
type
+type
String
+String
Indicates the volume type.
-Its value can be any of the following and is case-sensitive:
-- ULTRAHIGH: indicates the SSD type.
Disk type.
+Its value is case-sensitive and can be:
+- ULTRAHIGH, indicating SSD.
size
+size
Integer
+Integer
Indicates the volume size.
-When creating a distributed instance, you need to specify the size to be a multiple of the number of shards multiplied by 40 GB, ranging from the number of shards multiplied by 40 GB to the number of shards multiplied by 16 TB.
+Storage.
+When creating a distributed instance, you need to specify the storage to be a multiple of (Number of shards x 40 GB), ranging from (Number of shards x 40 GB) to (Number of shards x 16 TB).
Table 14 chargeInfo field data structure description Name
+-Table 14 charge_Info field data structure description Name
Type
+Type
Description
+Description
charge_mode
+charge_mode
String
+String
Indicates the billing information, which is pay-per-use.
+Billing mode. The value can only be postPaid.
- Example normal response
Creating a DB instance of the enterprise edition: +
- Example normal response+
Creating a DB instance of the enterprise edition: { "instance": { "id": "ad8cd1440aa94a02ae4580fcbebb3143in14", "name": "user1-v3-independent", "status": "BUILD", "datastore": { - "type": "GaussDB(openGauss)", - "version": "1.1" + "type": "GaussDB", + "version": "1.4" }, "ha": { "mode": "Enterprise", "replication_mode": "sync", - "consistency": "strong" + "consistency": "strong", + "consistency_protocol":"quorum" }, "port": "8000", "volume": { "type": "ULTRAHIGH", "size": 120 }, + "replica_num": 3, "region": "eu-de", "backup_strategy": { "start_time": "17:00-18:00", "keep_days": 7 }, - "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", + "flavor_ref":"gaussdb.opengauss.ee.dn.m4.2xlarge.8.in", "availability_zone": "eu-de-01,eu-de-01,eu-de-01", + "availability_zone": "bbb,ccc", "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", @@ -757,18 +802,22 @@ } }, "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af" -}-- Abnormal response
For details, see Abnormal Request Results.
+} + + - Abnormal response
- Abnormal response
For details, see Abnormal Request Results.
Status Codes
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/opengauss/api-ref/opengauss_api_0016.html b/docs/opengauss/api-ref/opengauss_api_0016.html index ef9a2ea3..babde72d 100644 --- a/docs/opengauss/api-ref/opengauss_api_0016.html +++ b/docs/opengauss/api-ref/opengauss_api_0016.html @@ -1,35 +1,38 @@ - + --Parent topic: DB Instance Management+Parent topic: Instance ManagementScaling Up Storage Space of a DB Instance
-Function
This API is used to scale up storage space of a DB instance.
-- Before calling an API, you need to understand the API in Using APIs.
- Before calling this API, obtain the required region and endpoint.
Adding CNs, Adding Shards, or Scaling Up Storage
+-Function
This API is used to add CNs, add shards, or scale up storage. Before calling this API:
+- Learn how to authenticate this API.
- Understand the API in Using APIs.
- Obtain the required region and endpoint.
Constraints
- The storage space must be a multiple of the number of shards multiplied by 40 GB.
- All nodes must be available.
-Constraints
- Adding CNs
- The maximum number of CNs is 256.
- If you choose the single-AZ deployment during instance creation, add CNs in the same AZ.
- Adding shards
- The shard growth increment ranges from 1 to 64.
- The maximum number of shards is 256.
- Scaling up Storage
- The storage space must be a multiple of (Number of shards x 40 GB).
- All nodes must be available.
URI
- URI format
POST https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}/action
- - Example
https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
- - Parameter description
-
Table 1 Parameter description Name
+URI
- URI format
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action
+ - Example
https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/action
+ - Parameter description
+
Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
-For details about how to obtain the project ID, see Obtaining a Project ID.
+Project ID of a tenant in a region.
+To obtain this value, see Obtaining a Project ID.
instance_id
+instance_id
Yes
+Yes
Specifies the DB instance ID.
+Instance ID.
Request
- Parameter description
-
Table 2 Parameter description Name
+Request
- Parameter description
+-
Table 2 Parameter description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
enlarge_volume
+expand_cluster
Yes
+No
Object
+Object
Specifies the target storage space after scaling up.
-For details, see Table 3.
+This parameter is mandatory when you add CNs or shards.
+For details, see Table 3.
+enlarge_volume
+No
+Object
+New storage space after scaling up. This parameter is mandatory for scaling up storage.
+For details, see Table 6.
Table 3 enlarge_volume field data structure description Name
++ +
+Table 3 expand_cluster field data structure description Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
size
+coordinators
Yes
+No
Integer
+Array of Coordinators objects
Specifies the storage space, which must always be an integral multiple of (Number of shards x 40 GB). Minimum storage space = Number of shards x 40 GB. Maximum storage space = Number of shards x 16 TB.
+This parameter is mandatory for adding CNs. For details, see Table 4.
+shard
+No
+Shard object
+This parameter is mandatory for adding shards. For details, see Table 5.
++ +
+Table 4 coordinators parameter description Name
+Mandatory
+Type
+Description
+az_code
+Yes
+string
+AZs to which CNs are to be added. If multiple CNs need to be added, enter the AZ where each CN is located.
++ +
+Table 5 shard parameter description Name
+Mandatory
+Type
+Description
+count
+Yes
+integer
+Number of shards to be added.
+Table 6 enlarge_volume field data structure description Name
+Mandatory
+Type
+Description
+size
+Yes
+Integer
+Storage space, which must always be a multiple of (Number of shards x 40 GB). Value range: (Number of shards x 40 GB) to (Number of shards x 16 TB).
- Request example
{ - "enlarge_volume": { - "size": 400 - } +Example Request
- Adding a CN
{ + "expand_cluster": { + "coordinators": [ + { + "az_code": "eu-de-01" + } + ] + } }
Response
- Normal response
-
Table 4 Parameter description Name
+ +- Adding multiple CNs
{ + "expand_cluster": { + "coordinators": [ + { + "az_code": "eu-de-01" + }, + { + "az_code": "eu-de-01" + }, + { + "az_code": "eu-de-01" + } + ] + } +}+ - Adding a DN shard
{ + "expand_cluster": { + "shard": { + "count": 1 + } + } +}+ - Scaling up storage to 400 GB
{ + "enlarge_volume": { + "size": 400 + } +}+
Response
- Normal response
+
Table 7 Parameter description Name
Type
+Type
Description
+Description
job_id
+job_id
String
+String
Indicates the task ID.
+Task ID. This parameter is returned when your instance is billed at a pay-per-use basis.
- Example normal response
{ +- Example normal response
{ "job_id": "2b414788a6004883a02390e2eb0ea227" }- - Abnormal response
For details, see Abnormal Request Results.
+ - Abnormal response
For details, see Abnormal Request Results.
+
Status Code
- Normal +
- Abnormal
For details, see Status Codes.
-Status Codes
For details, see Status Codes.
diff --git a/docs/opengauss/api-ref/opengauss_api_0017.html b/docs/opengauss/api-ref/opengauss_api_0017.html index 11f8ab6a..966e6837 100644 --- a/docs/opengauss/api-ref/opengauss_api_0017.html +++ b/docs/opengauss/api-ref/opengauss_api_0017.html @@ -1,33 +1,33 @@ - +-Parent topic: DB Instance Management+Parent topic: Instance ManagementDeleting a DB Instance
-Function
This API is used to delete a DB instance.
-- Before calling an API, you need to understand the API in Using APIs.
- Before calling this API, obtain the required region and endpoint.
-Function
This API is used to delete a DB instance. Before calling this API:
+- Learn how to authenticate this API.
- Understand the API in Using APIs.
- Obtain the required region and endpoint.
URI
- URI format
DELETE https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}
- - Example
https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01
- - Parameter description
-
Table 1 Parameter description Name
+URI
- URI format
DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}
+ - Example
https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01
+ - Parameter description
+
Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID of a tenant in a region.
-For details about how to obtain the project ID, see Obtaining a Project ID.
+Project ID of a tenant in a region.
+To obtain this value, see Obtaining a Project ID.
instance_id
+instance_id
Yes
+Yes
Specifies the DB instance ID compliant with the UUID format.
+Instance ID.
Request
None
+-Request
None
Response
- Normal response
-
Table 2 Parameter description Name
+-Response
- Normal response
+-
Table 2 Parameter description Name
Type
+Type
Description
+Description
job_id
+job_id
String
+String
Indicates the ID of the DB instance deletion task.
+ID of the instance deletion task.
- Example normal response
{ + - Example normal response
{ "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" }- - Abnormal response
For details, see Abnormal Request Results.
+ - Abnormal response
For details, see Abnormal Request Results.
Status Codes
For details, see Status Codes.
+-Status Code
- Normal +
- Abnormal
For details, see Status Codes.
+
diff --git a/docs/opengauss/api-ref/opengauss_api_0018.html b/docs/opengauss/api-ref/opengauss_api_0018.html index 699046fe..47a2c3e1 100644 --- a/docs/opengauss/api-ref/opengauss_api_0018.html +++ b/docs/opengauss/api-ref/opengauss_api_0018.html @@ -1,109 +1,110 @@ - + --Parent topic: DB Instance Management+Parent topic: Instance ManagementQuerying Details About DB Instances
-Function
This API is used to query DB instances according to search criteria.
-- Before calling an API, you need to understand the API in Using APIs.
- Before calling this API, obtain the required region and endpoint.
Querying DB Instances
+-Function
This API is used to query instances according to search criteria. Before calling this API:
+- Learn how to authenticate this API.
- Understand the API in Using APIs.
- Obtain the required region and endpoint.
URI
- URI format
GET https://{Endpoint}/opengauss/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}
- - Example
- Querying all DB instances
https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/97b026aa9cc4417888c14c84a1ad9860/instances
- - Querying DB instances based on search criteria
https://gaussdb.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Enterprise&datastore_type=GaussDB(openGauss)&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10
+URI
- URI format
GET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}
+ - Example
- Querying all instances
https://gaussdb.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances
+ - Querying instances based on search criteria
https://gaussdb.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Enterprise&datastore_type=GaussDB&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10
- Querying all instances
- Parameter description
-
Table 1 Parameter description Name
+- Parameter description +
Table 1 Parameter description Name
Type
+Type
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
String
+String
Yes
+Yes
Specifies the project ID of a tenant in a region.
-For details about how to obtain the project ID, see Obtaining a Project ID.
+Project ID of a tenant in a region.
+To obtain this value, see Obtaining a Project ID.
id
+id
String
+String
No
+No
Specifies the DB instance ID.
-The asterisk (*) is reserved for the system. If the instance ID starts with *, it indicates that fuzzy match is performed based on the value following * Otherwise, the exact match is performed based on the instance ID. The value cannot contain only asterisks (*).
+Instance ID.
+The asterisk (*) is reserved for the system. If the instance ID starts with *, it indicates that fuzzy match is performed based on the value following *. Otherwise, the exact match is performed based on the instance ID. The value cannot contain only asterisks (*).
name
+name
String
+String
No
+No
Specifies the DB instance name.
-The asterisk (*) is reserved for the system. If the instance name starts with *, it indicates that fuzzy match is performed based on the value following * Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (*).
+DB instance name.
+The asterisk (*) is reserved for the system. If the instance name starts with *, it indicates that fuzzy match is performed based on the value following *. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (*).
type
+type
String
+String
No
+No
Specifies the instance type-based query. Currently, the value is only Enterprise (case-sensitive), indicating the distributed instance (Enterprise Edition).
+Instance type to be queried. Currently, the following values are supported:
+- Enterprise (case-sensitive): distributed instances (in the independent deployment).
datastore_type
+datastore_type
String
+String
No
+No
Specifies the database type. Its value is case-sensitive.
-- GaussDB(openGauss)
Database type. Its value is case-insensitive.
+GaussDB
vpc_id
+vpc_id
String
+String
No
+No
Specifies the VPC ID.
-- Method 1: Log in to VPC console and view the VPC ID in the VPC details.
- Method 2: See the "Querying VPCs" section in the Virtual Private Cloud API Reference.
VPC ID. To obtain this parameter value, use the following methods:
+- Method 1: Log in to VPC console and view the VPC ID in the VPC details.
- Method 2: See the section "Querying VPCs" in the Virtual Private Cloud API Reference.
subnet_id
+subnet_id
String
+String
No
+No
Specifies the network ID of the subnet.
-- Method 1: Log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
- Method 2: See the "Querying Subnets" section in the Virtual Private Cloud API Reference.
- Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in the Virtual Private Cloud API Reference.
Network ID of the subnet.
+- Method 1: Log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
- Method 2: See section "Querying Subnets" under "APIs" or section "Querying Networks" under "OpenStack Neutron APIs" in the Virtual Private Cloud API Reference.
offset
+offset
Integer
+Integer
No
+No
Specifies the index position. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a positive number.
+Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The default value is 0, indicating that the query starts from the first piece of data. The value cannot be a negative number.
limit
+limit
Integer
+Integer
No
+No
Specifies the number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.
+Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.
Request
None
+-Request
None
Response
- Normal response
-
Table 2 Parameter description Name
+Response
- Normal response
+-
Table 2 Parameter description Name
Type
+Type
Description
+Description
instances
+instances
Array of objects
+Array of objects
Indicates the DB instance information.
-For details, see Table 3.
+Instance information.
+For details, see Table 3.
total_count
+total_count
Integer
+Integer
Indicates the total number of records.
+Total number of records.
Table 3 instances field data structure description Name
+-Table 3 instances field data structure description Name
Type
+Type
Description
+Description
id
+id
String
+String
Indicates the DB instance ID.
+Instance ID.
name
+name
String
+String
Indicates the created DB instance name.
+Instance name.
status
+status
String
+String
Indicates the DB instance status.
-Value:
-If the value is BUILD, the DB instance is being created.
-If the value is ACTIVE, the DB instance is normal.
-If the value is FAILED, the DB instance is abnormal.
-If the value is EXPANDING, CNs or shards are being added to the DB instance.
-If the value is REBOOTING, the DB instance is being rebooted.
-If the value is BACKING UP, the DB instance is being backed up.
+Instance status.
+Value:
+If the value is BUILD, the instance is being created.
+If the value is ACTIVE, the instance is normal.
+If the value is FAILED, the instance is abnormal.
+If the value is MODIFYING, the storage is being scaled up or instance specifications are being changed.
+If the value is EXPANDING, CNs or DNs are being added to the instance.
+If the value is REBOOTING, the instance is being rebooted.
+If the value is UPGRADING, the instance is being upgraded.
+If the value is RESTORING, the instance is being restored.
+If the value is SWITCHOVER, the primary/standby switchover is being performed.
+If the value is MIGRATING, the instance is being migrated.
+If the value is BACKING UP, the instance is being backed up.
+If the value is UPGRADE TO BE OBSERVED, the instance upgrade is in the observation period.
+If the value is STORAGE FULL, the instance storage is full.
private_ips
+private_ips
List<String>
+List<String>
Indicates the private IP address list. It is a blank string until an ECS is created.
+Private IP address list. The value is an empty string until ECSs where CNs of distributed instances are deployed or ECSs where DNs of primary/standby instances are deployed are created.
public_ips
+port
List<String>
+Integer
Indicates the public IP address list.
+Database port number. The GaussDB database port is from 1024 to 39998 (excluding the following which are occupied by the system and cannot be used: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 20049, 20050, 21731, and 21732).
port
+type
Integer
+String
Indicates the database port number.
-- The GaussDB(openGauss) database port ranges from 1024 to 39998 (excluding the following which are occupied by the system and cannot be used: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 20049, 20050, 21731, and 21732).
If this parameter is not specified,
-- the default value of GaussDB(openGauss) is 8000.
Instance type. The value is case-sensitive. The value Enterprise indicates the distributed instance (Enterprise Edition).
type
+ha
String
+Object
Indicates the instance type. The value is Enterprise, indicating the distributed instance (Enterprise Edition).
+Instance high availability.
+For details, see Table 4.
ha
+replica_num
Object
+Integer
Returned when a distributed instance is obtained.
-For details, see Table 4.
+Number of replicas.
region
+region
String
+String
Indicates the region where the DB instance is deployed.
+Region where the instance is deployed.
datastore
+datastore
Object
+Object
Indicates the database information.
-For details, see Table 5.
+Database information.
+For details, see Table 5.
created
+created
String
+String
Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format.
-T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.
-The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.
+Creation time in the "yyyy-mm-dd hh:mm:ss timezone" format.
+timezone indicates the time zone.
+When the instance is being created, the value is the time when the creation request is delivered. After the instance is created, the value is the time when the creation is complete.
updated
+updated
String
+String
Indicates the update time. The format is the same as that of the created field.
-The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.
+Update time. The format is the same as that of the created field.
+The value is empty when the instance is being created. After the instance is created, the value is not empty.
db_user_name
+db_user_name
String
+String
Indicates the default username.
+Default username.
vpc_id
+vpc_id
String
+String
Indicates the VPC ID.
+VPC ID.
subnet_id
+subnet_id
String
+String
Indicates the network ID of the subnet.
+Network ID of the subnet.
security_group_id
+security_group_id
String
+String
Indicates the security group ID.
+Security group ID.
flavor_ref
+flavor_ref
String
+String
Indicates the specification code. For details on how to obtain the GaussDB(openGauss) specification code, see Table 1.
+Specification code. For details on how to obtain the GaussDB specification code, see DB Instance Specifications.
volume
+flavor_info
Object
+Object
Indicates the volume information.
-For details, see Table 6.
+Flavor information.
+For details, see Table 6.
switch_strategy
+volume
String
+Object
Indicates the database switchover policy. The value can be reliability or availability, indicating the reliability first and availability first, respectively.
+Volume information.
+For details, see Table 7.
backup_strategy
+backup_strategy
Object
+Object
Indicates the backup policy.
-For details, see Table 7.
+Backup policy.
+For details, see Table 8.
maintenance_window
+maintenance_window
String
+String
Indicates the start time of the maintenance time window in the UTC format.
+Maintenance window in the UTC format.
nodes
+nodes
Array of objects
+Array of objects
Indicates the instance node information.
-For details, see Table 8.
+Instance node information.
+For details, see Table 9.
related_instance
+disk_encryption_id
Array of objects
+String
Indicates the list of associated DB instances. The parameters are not involved in GaussDB(openGauss).
+Disk encryption key ID. This parameter is displayed only when the instance disk is encrypted.
time_zone
+instance_mode
String
+String
Indicates the time zone.
+enterprise indicates enterprise edition.
+time_zone
+String
+Time zone.
+backup_used_space
+String
+Used backup space, in KB.
- Normal response
+
- Parameter description +
- URI format
- Querying all DB instances
- Normal response
+
- Normal response
-
- URI format
- Example normal response
- Example normal response
- Adding multiple CNs
- Adding a CN
- Request example
- Parameter description
+
- Parameter description
-
- URI format
- Example normal response
- Normal response
+
- Domain
