diff --git a/docs/opengauss/api-ref/ALL_META.TXT.json b/docs/opengauss/api-ref/ALL_META.TXT.json index c0723350..8d914a51 100644 --- a/docs/opengauss/api-ref/ALL_META.TXT.json +++ b/docs/opengauss/api-ref/ALL_META.TXT.json @@ -985,11 +985,62 @@ "title":"Modifying the Recycling Policy", "githuburl":"" }, + { + "uri":"opengauss_query_api_version.html", + "node_id":"en-us_topic_0000001917130508.xml", + "product_code":"", + "code":"48", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"", + "kw":"API Version Query", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"API Version Query", + "githuburl":"" + }, + { + "uri":"opengauss_query_version_list.html", + "node_id":"en-us_topic_0000001917290504.xml", + "product_code":"", + "code":"49", + "des":"This API is used to query the supported API versions. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required regi", + "doc_type":"", + "kw":"Querying API Versions,API Version Query,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Querying API Versions", + "githuburl":"" + }, + { + "uri":"opengauss_query_version_info.html", + "node_id":"en-us_topic_0000001917130784.xml", + "product_code":"", + "code":"50", + "des":"This API is used to query version information of a specified API. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the r", + "doc_type":"", + "kw":"Querying Version Information of an API,API Version Query,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Querying Version Information of an API", + "githuburl":"" + }, { "uri":"opengauss_api_1013.html", "node_id":"en-us_topic_0000001917290668.xml", "product_code":"opengauss", - "code":"48", + "code":"51", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Historical APIs", @@ -1010,7 +1061,7 @@ "uri":"opengauss_api_1014.html", "node_id":"en-us_topic_0000001917130712.xml", "product_code":"opengauss", - "code":"49", + "code":"52", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"DB Instance Management", @@ -1031,7 +1082,7 @@ "uri":"opengauss_api_1016.html", "node_id":"en-us_topic_0000001917130496.xml", "product_code":"opengauss", - "code":"50", + "code":"53", "des":"This API is used to scale up storage space of a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the requir", "doc_type":"api", "kw":"Scaling up Storage Space of a DB Instance,DB Instance Management,API Reference", @@ -1052,7 +1103,7 @@ "uri":"opengauss_api_1017.html", "node_id":"en-us_topic_0000001917290420.xml", "product_code":"opengauss", - "code":"51", + "code":"54", "des":"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 endpo", "doc_type":"api", "kw":"Deleting a DB Instance,DB Instance Management,API Reference", @@ -1073,7 +1124,7 @@ "uri":"opengauss_api_1019.html", "node_id":"en-us_topic_0000001947569549.xml", "product_code":"opengauss", - "code":"52", + "code":"55", "des":"This API is used to add CNs.Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpoint.The CN growth increment ranges fro", "doc_type":"api", "kw":"Adding CNs,DB Instance Management,API Reference", @@ -1094,7 +1145,7 @@ "uri":"opengauss_api_1020.html", "node_id":"en-us_topic_0000001947569473.xml", "product_code":"opengauss", - "code":"53", + "code":"56", "des":"This API is used to add shards.Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpoint.Intermittent disconnection occu", "doc_type":"api", "kw":"Adding Shards,DB Instance Management,API Reference", @@ -1115,7 +1166,7 @@ "uri":"opengauss_api_1023.html", "node_id":"en-us_topic_0000001917290400.xml", "product_code":"opengauss", - "code":"54", + "code":"57", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Parameter Configuration", @@ -1136,7 +1187,7 @@ "uri":"opengauss_api_1024.html", "node_id":"en-us_topic_0000001917290728.xml", "product_code":"opengauss", - "code":"55", + "code":"58", "des":"This API is used to modify parameters in the parameter template of a specified DB instance. Before calling this API:Learn how to authenticate this API.Understand the API ", "doc_type":"api", "kw":"Modifying Parameters of a Specified DB Instance,Parameter Configuration,API Reference", @@ -1157,7 +1208,7 @@ "uri":"opengauss_api_0030.html", "node_id":"en-us_topic_0000001947569769.xml", "product_code":"opengauss", - "code":"56", + "code":"59", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendix", @@ -1178,7 +1229,7 @@ "uri":"opengauss_api_0031.html", "node_id":"en-us_topic_0000001917290524.xml", "product_code":"opengauss", - "code":"57", + "code":"60", "des":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_ms", "doc_type":"api", "kw":"Abnormal Request Results,Appendix,API Reference", @@ -1199,7 +1250,7 @@ "uri":"opengauss_api_0032.html", "node_id":"en-us_topic_0000001917130452.xml", "product_code":"opengauss", - "code":"58", + "code":"61", "des":"Table 1 describes status codes.", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", @@ -1220,7 +1271,7 @@ "uri":"opengauss_api_0033.html", "node_id":"en-us_topic_0000001947569625.xml", "product_code":"opengauss", - "code":"59", + "code":"62", "des":"The following table describes error codes.", "doc_type":"api", "kw":"Error Codes,Appendix,API Reference", @@ -1241,7 +1292,7 @@ "uri":"opengauss_api_0034.html", "node_id":"en-us_topic_0000001917130752.xml", "product_code":"opengauss", - "code":"60", + "code":"63", "des":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID using either of the following methods:Obtaining the Projec", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -1262,7 +1313,7 @@ "uri":"opengauss_api_0036.html", "node_id":"en-us_topic_0000001917290632.xml", "product_code":"opengauss", - "code":"61", + "code":"64", "des":"Replication mode table", "doc_type":"api", "kw":"Replication Mode Table,Appendix,API Reference", @@ -1283,7 +1334,7 @@ "uri":"opengauss_api_0037.html", "node_id":"en-us_topic_0000001917130736.xml", "product_code":"opengauss", - "code":"62", + "code":"65", "des":"This section describes the GaussDB instance specifications.", "doc_type":"api", "kw":"DB Instance Specifications,Appendix,API Reference", @@ -1304,7 +1355,7 @@ "uri":"opengauss_api_0038.html", "node_id":"en-us_topic_0000001917290528.xml", "product_code":"opengauss", - "code":"63", + "code":"66", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/opengauss/api-ref/CLASS.TXT.json b/docs/opengauss/api-ref/CLASS.TXT.json index d01bd80e..de050be9 100644 --- a/docs/opengauss/api-ref/CLASS.TXT.json +++ b/docs/opengauss/api-ref/CLASS.TXT.json @@ -422,6 +422,33 @@ "p_code":"46", "code":"47" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"opengauss", + "title":"API Version Query", + "uri":"opengauss_query_api_version.html", + "doc_type":"api", + "p_code":"13", + "code":"48" + }, + { + "desc":"This API is used to query the supported API versions. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required regi", + "product_code":"opengauss", + "title":"Querying API Versions", + "uri":"opengauss_query_version_list.html", + "doc_type":"api", + "p_code":"48", + "code":"49" + }, + { + "desc":"This API is used to query version information of a specified API. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the r", + "product_code":"opengauss", + "title":"Querying Version Information of an API", + "uri":"opengauss_query_version_info.html", + "doc_type":"api", + "p_code":"48", + "code":"50" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"opengauss", @@ -429,7 +456,7 @@ "uri":"opengauss_api_1013.html", "doc_type":"api", "p_code":"", - "code":"48" + "code":"51" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -437,8 +464,8 @@ "title":"DB Instance Management", "uri":"opengauss_api_1014.html", "doc_type":"api", - "p_code":"48", - "code":"49" + "p_code":"51", + "code":"52" }, { "desc":"This API is used to scale up storage space of a DB instance. Before calling this API:Learn how to authenticate this API.Understand the API in Using APIs.Obtain the requir", @@ -446,8 +473,8 @@ "title":"Scaling up Storage Space of a DB Instance", "uri":"opengauss_api_1016.html", "doc_type":"api", - "p_code":"49", - "code":"50" + "p_code":"52", + "code":"53" }, { "desc":"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 endpo", @@ -455,8 +482,8 @@ "title":"Deleting a DB Instance", "uri":"opengauss_api_1017.html", "doc_type":"api", - "p_code":"49", - "code":"51" + "p_code":"52", + "code":"54" }, { "desc":"This API is used to add CNs.Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpoint.The CN growth increment ranges fro", @@ -464,8 +491,8 @@ "title":"Adding CNs", "uri":"opengauss_api_1019.html", "doc_type":"api", - "p_code":"49", - "code":"52" + "p_code":"52", + "code":"55" }, { "desc":"This API is used to add shards.Learn how to authenticate this API.Understand the API in Using APIs.Obtain the required region and endpoint.Intermittent disconnection occu", @@ -473,8 +500,8 @@ "title":"Adding Shards", "uri":"opengauss_api_1020.html", "doc_type":"api", - "p_code":"49", - "code":"53" + "p_code":"52", + "code":"56" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -482,8 +509,8 @@ "title":"Parameter Configuration", "uri":"opengauss_api_1023.html", "doc_type":"api", - "p_code":"48", - "code":"54" + "p_code":"51", + "code":"57" }, { "desc":"This API is used to modify parameters in the parameter template of a specified DB instance. Before calling this API:Learn how to authenticate this API.Understand the API ", @@ -491,8 +518,8 @@ "title":"Modifying Parameters of a Specified DB Instance", "uri":"opengauss_api_1024.html", "doc_type":"api", - "p_code":"54", - "code":"55" + "p_code":"57", + "code":"58" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -501,7 +528,7 @@ "uri":"opengauss_api_0030.html", "doc_type":"api", "p_code":"", - "code":"56" + "code":"59" }, { "desc":"Abnormal response descriptionAbnormal response descriptionNameTypeDescriptionerror_codeStringSpecifies the error returned when a task submission exception occurs.error_ms", @@ -509,8 +536,8 @@ "title":"Abnormal Request Results", "uri":"opengauss_api_0031.html", "doc_type":"api", - "p_code":"56", - "code":"57" + "p_code":"59", + "code":"60" }, { "desc":"Table 1 describes status codes.", @@ -518,8 +545,8 @@ "title":"Status Codes", "uri":"opengauss_api_0032.html", "doc_type":"api", - "p_code":"56", - "code":"58" + "p_code":"59", + "code":"61" }, { "desc":"The following table describes error codes.", @@ -527,8 +554,8 @@ "title":"Error Codes", "uri":"opengauss_api_0033.html", "doc_type":"api", - "p_code":"56", - "code":"59" + "p_code":"59", + "code":"62" }, { "desc":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID using either of the following methods:Obtaining the Projec", @@ -536,8 +563,8 @@ "title":"Obtaining a Project ID", "uri":"opengauss_api_0034.html", "doc_type":"api", - "p_code":"56", - "code":"60" + "p_code":"59", + "code":"63" }, { "desc":"Replication mode table", @@ -545,8 +572,8 @@ "title":"Replication Mode Table", "uri":"opengauss_api_0036.html", "doc_type":"api", - "p_code":"56", - "code":"61" + "p_code":"59", + "code":"64" }, { "desc":"This section describes the GaussDB instance specifications.", @@ -554,8 +581,8 @@ "title":"DB Instance Specifications", "uri":"opengauss_api_0037.html", "doc_type":"api", - "p_code":"56", - "code":"62" + "p_code":"59", + "code":"65" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -564,6 +591,6 @@ "uri":"opengauss_api_0038.html", "doc_type":"api", "p_code":"", - "code":"63" + "code":"66" } ] \ No newline at end of file diff --git a/docs/opengauss/api-ref/opengauss_api_0013.html b/docs/opengauss/api-ref/opengauss_api_0013.html index 4a553e78..fc031e65 100644 --- a/docs/opengauss/api-ref/opengauss_api_0013.html +++ b/docs/opengauss/api-ref/opengauss_api_0013.html @@ -18,6 +18,8 @@
  • Recycle Bin
    • +
  • API Version Query
    +
    • diff --git a/docs/opengauss/api-ref/opengauss_api_0038.html b/docs/opengauss/api-ref/opengauss_api_0038.html index ddccd3e7..6fa86c82 100644 --- a/docs/opengauss/api-ref/opengauss_api_0038.html +++ b/docs/opengauss/api-ref/opengauss_api_0038.html @@ -8,7 +8,12 @@ -

    2024-08-05

    +

    2024-11-20

    + + + + +

    2024-08-05

    diff --git a/docs/opengauss/api-ref/opengauss_newapi_0006.html b/docs/opengauss/api-ref/opengauss_newapi_0006.html index a0e30e29..11263f13 100644 --- a/docs/opengauss/api-ref/opengauss_newapi_0006.html +++ b/docs/opengauss/api-ref/opengauss_newapi_0006.html @@ -55,9 +55,15 @@ diff --git a/docs/opengauss/api-ref/opengauss_query_api_version.html b/docs/opengauss/api-ref/opengauss_query_api_version.html new file mode 100644 index 00000000..92ec44c0 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_query_api_version.html @@ -0,0 +1,18 @@ + + +

    API Version Query

    +

    +
    +
    + + +
    +
    Parent topic: APIs (Recommended)
    +
    +
    + diff --git a/docs/opengauss/api-ref/opengauss_query_version_info.html b/docs/opengauss/api-ref/opengauss_query_version_info.html new file mode 100644 index 00000000..c0b62699 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_query_version_info.html @@ -0,0 +1,167 @@ + + +

    Querying Version Information of an API

    +

    Function

    This API is used to query version information of a specified API. Before calling this API:

    + +
    +

    URI

    +
    +

    Request

    None

    +
    +

    Response

    +
    + +

    Status Code

    +
    +

    Error Code

    For details, see Error Codes.

    +
    +
    +
    +
    +
    Parent topic: API Version Query
    +
    +
    + diff --git a/docs/opengauss/api-ref/opengauss_query_version_list.html b/docs/opengauss/api-ref/opengauss_query_version_list.html new file mode 100644 index 00000000..8debe935 --- /dev/null +++ b/docs/opengauss/api-ref/opengauss_query_version_list.html @@ -0,0 +1,158 @@ + + +

    Querying API Versions

    +

    Function

    This API is used to query the supported API versions. Before calling this API:

    + +
    +

    URI

    +
    +

    Request

    None

    +
    +

    Response

    +
    + +

    Status Code

    +
    +

    Error Code

    For details, see Error Codes.

    +
    +
    +
    +
    +
    Parent topic: API Version Query
    +
    +
    +