forked from docs/doc-exports
qiujiandong1
535e30e292
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
479 lines
18 KiB
JSON
479 lines
18 KiB
JSON
[
|
|
{
|
|
"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":"ucs",
|
|
"title":"Before You Start",
|
|
"uri":"ucs_api_0001.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"1"
|
|
},
|
|
{
|
|
"desc":"Ubiquitous Cloud Native Service (UCS) is the first distributed cloud native product in the industry. It provides a consistent experience in cloud native application deplo",
|
|
"product_code":"ucs",
|
|
"title":"Overview",
|
|
"uri":"ucs_api_0002.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"desc":"UCS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.",
|
|
"product_code":"ucs",
|
|
"title":"API Calling",
|
|
"uri":"ucs_api_0003.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"3"
|
|
},
|
|
{
|
|
"desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. The endpoint of UCS consists of the service name, region ID, and ",
|
|
"product_code":"ucs",
|
|
"title":"Endpoints",
|
|
"uri":"ucs_api_0004.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"UCS imposes quotas on the number and capacity of resources that a user can access. By default, you can create a maximum of 50 fleets, 50 clusters, and 50 permission polic",
|
|
"product_code":"ucs",
|
|
"title":"Constraints",
|
|
"uri":"ucs_api_0005.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"5"
|
|
},
|
|
{
|
|
"desc":"DomainA domain is created upon successful signing up. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user pas",
|
|
"product_code":"ucs",
|
|
"title":"Concepts",
|
|
"uri":"ucs_api_0006.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"Calling APIs",
|
|
"uri":"ucs_api_0007.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"7"
|
|
},
|
|
{
|
|
"desc":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user tokenobtaining a user token as an example to demonstrate how to call",
|
|
"product_code":"ucs",
|
|
"title":"Making an API Request",
|
|
"uri":"ucs_api_0008.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"8"
|
|
},
|
|
{
|
|
"desc":"Requests for calling an API can be authenticated using an AK/SK pair.An AK/SK is used to verify the identity of a request sender. In AK/SK authentication, a signature nee",
|
|
"product_code":"ucs",
|
|
"title":"Authentication",
|
|
"uri":"ucs_api_0009.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ",
|
|
"product_code":"ucs",
|
|
"title":"Response",
|
|
"uri":"ucs_api_0010.html",
|
|
"doc_type":"api",
|
|
"p_code":"7",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"API",
|
|
"uri":"ucs_api_0011.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"11"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"UCS Clusters",
|
|
"uri":"topic_300000000.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the cluster list.GET /v1/clustersStatus code: 200NoneStatus code: 200Information about all clusters is obtained.See Error Codes.",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining the Cluster List",
|
|
"uri":"ShowClusterList.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the cluster. Otherwi",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining a Cluster",
|
|
"uri":"ShowCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"This API is used to register a cluster. Third-party clusters and CCE clusters can be registered.POST /v1/clustersStatus code: 201Registering a CCE cluster{\n \"metadata\" :",
|
|
"product_code":"ucs",
|
|
"title":"Registering a Cluster",
|
|
"uri":"RegisterCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to update a cluster. Currently, only the country/city of attached clusters and on-premises clusters, and the number of worker nodes in a multi-cloud clus",
|
|
"product_code":"ucs",
|
|
"title":"Updating a Cluster",
|
|
"uri":"UpdateCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"This API is used to unregister a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permissions on the correspondin",
|
|
"product_code":"ucs",
|
|
"title":"Unregistering a Cluster",
|
|
"uri":"DeleteCluster.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the cluster access information. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the permission to query the",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining Cluster Access Information",
|
|
"uri":"ShowClusterAccessInfo.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"desc":"This API is used to activate a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permission on the corresponding c",
|
|
"product_code":"ucs",
|
|
"title":"Activating a Cluster",
|
|
"uri":"RetryClusterActivation.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the CCE cluster list of the current tenant.GET /v1/managedclustersStatus code: 200NoneStatus code: 200CCE clusters that are not registered with",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining the CCE Cluster List of a Tenant",
|
|
"uri":"ListManagedClusters.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the version list of clusters that can be connected to UCS.GET /v1/config/registeredclusterversionsStatus code: 200NoneStatus code: 200Version li",
|
|
"product_code":"ucs",
|
|
"title":"Querying the Version List of Clusters That Can Be Connected to UCS",
|
|
"uri":"ListRegisteredClusterVersions.html",
|
|
"doc_type":"api",
|
|
"p_code":"12",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"Fleets",
|
|
"uri":"topic_300000001.html",
|
|
"doc_type":"api",
|
|
"p_code":"11",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"This API is used to add a cluster to a fleet.POST /v1/clusters/{clusterid}/joinNoneAdding a cluster to a fleetStatus code: 200The cluster has been added to the fleet.See ",
|
|
"product_code":"ucs",
|
|
"title":"Adding a Cluster to a Fleet",
|
|
"uri":"JoinGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"This API is used to remove a cluster from a fleet.POST /v1/clusters/{clusterid}/unjoinNoneNoneNoneSee Error Codes.",
|
|
"product_code":"ucs",
|
|
"title":"Removing a Cluster from a Fleet",
|
|
"uri":"LeaveGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a fleet. You can select clusters during fleet creation.POST /v1/clustergroupsStatus code: 201Creating a fleet and (optional) adding clusters to",
|
|
"product_code":"ucs",
|
|
"title":"Creating a Fleet",
|
|
"uri":"RegisterClusterGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a fleet. A fleet can only be deleted when there are no clusters in it. To delete a fleet, remove the clusters from the fleet first. The cluster",
|
|
"product_code":"ucs",
|
|
"title":"Deleting a Fleet",
|
|
"uri":"DeleteClusterGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain a fleet.GET /v1/clustergroups/{clustergroupid}Status code: 200NoneStatus code: 200Fleet objectSee Error Codes.",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining a Fleet",
|
|
"uri":"ShowClusterGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"desc":"This API is used to add clusters to a fleet. One or more clusters can be added at the same time. This API cannot be used to remove all or some clusters from a fleet.PUT /",
|
|
"product_code":"ucs",
|
|
"title":"Adding Clusters to a Fleet",
|
|
"uri":"UpdateClusterGroupAssociatedClusters.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"desc":"This API is used to update the description of a fleet. You must have the permissions to update the fleet.PUT /v1/clustergroups/{clustergroupid}/descriptionNoneUpdating fl",
|
|
"product_code":"ucs",
|
|
"title":"Updating Fleet Description",
|
|
"uri":"UpdateClusterGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the fleet list.GET /v1/clustergroupsStatus code: 200NoneStatus code: 200The fleet list has been obtained.See Error Codes.",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining the Fleet List",
|
|
"uri":"ListClusterGroup.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"desc":"This API is used to enable cluster federation.POST /v1/clustergroups/{clustergroupid}/federationsStatus code: 201container fleet has in enable federation progress.Status ",
|
|
"product_code":"ucs",
|
|
"title":"Enabling Cluster Federation",
|
|
"uri":"EnableFederation.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"desc":"This API is used to disable cluster federation for a fleet.DELETE /v1/clustergroups/{clustergroupid}/federationsNoneNoneStatus code: 200Cluster federation has been disabl",
|
|
"product_code":"ucs",
|
|
"title":"Disabling Cluster Federation",
|
|
"uri":"DisableFederation.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"32"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the federation enabling progress.GET /v1/clustergroups/{clustergroupid}/federations/progressStatus code: 200NoneStatus code: 200Job for enabling",
|
|
"product_code":"ucs",
|
|
"title":"Querying Federation Enabling Progress",
|
|
"uri":"ShowFederationProgress.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"33"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a VPC endpoint for connecting to the federation API server and downloading kubeconfig of the federation API server after federation is enabled ",
|
|
"product_code":"ucs",
|
|
"title":"Creating a Federation Connection and Downloading kubeconfig",
|
|
"uri":"CreateFederationCert.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"34"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a VPC endpoint for connecting to the federation API server after federation is enabled for a fleet.POST /v1/clustergroups/{clustergroupid}/conn",
|
|
"product_code":"ucs",
|
|
"title":"Creating a Federation Connection",
|
|
"uri":"CreateFederationConnection.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"35"
|
|
},
|
|
{
|
|
"desc":"This API is used to download the kubeconfig after the cluster federation is enabled for a fleet and the federation connection is created.POST /v1/clustergroups/{clustergr",
|
|
"product_code":"ucs",
|
|
"title":"Downloading Federation kubeconfig",
|
|
"uri":"DownloadFederationKubeconfig.html",
|
|
"doc_type":"api",
|
|
"p_code":"22",
|
|
"code":"36"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"Outdated APIs",
|
|
"uri":"en-us_topic_0000002551843195.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"37"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"UCS Cluster",
|
|
"uri":"en-us_topic_0000002551763211.html",
|
|
"doc_type":"api",
|
|
"p_code":"37",
|
|
"code":"38"
|
|
},
|
|
{
|
|
"desc":"This API is used to associate a cluster with permission policies.PUT /v1/clusters/{clusterid}/associatedrulesNoneAssociating a cluster with permission policiesNoneSee Err",
|
|
"product_code":"ucs",
|
|
"title":"Associating a Cluster with Permission Policies",
|
|
"uri":"UpdateClusterRules.html",
|
|
"doc_type":"api",
|
|
"p_code":"38",
|
|
"code":"39"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"Fleet",
|
|
"uri":"en-us_topic_0000002520563224.html",
|
|
"doc_type":"api",
|
|
"p_code":"37",
|
|
"code":"40"
|
|
},
|
|
{
|
|
"desc":"This API is used to update the permission policies associated with a fleet.PUT /v1/clustergroups/{clustergroupid}/associatedrulesNoneUpdating the permission policies asso",
|
|
"product_code":"ucs",
|
|
"title":"Updating Permission Policies Associated with a Fleet",
|
|
"uri":"UpdateClusterGroupAssociatedRules.html",
|
|
"doc_type":"api",
|
|
"p_code":"40",
|
|
"code":"41"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"Permissions",
|
|
"uri":"topic_300000002.html",
|
|
"doc_type":"api",
|
|
"p_code":"37",
|
|
"code":"42"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a permission policy.POST /v1/permissions/rulesStatus code: 201Creating a permission policyStatus code: 201The UID of the new permission policy ",
|
|
"product_code":"ucs",
|
|
"title":"Creating a Permission Policy",
|
|
"uri":"CreateRule.html",
|
|
"doc_type":"api",
|
|
"p_code":"42",
|
|
"code":"43"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain the permission policy list.GET /v1/permissions/rulesStatus code: 200NoneStatus code: 200Permission policy listSee Error Codes.",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining the Permission Policy List",
|
|
"uri":"ListRule.html",
|
|
"doc_type":"api",
|
|
"p_code":"42",
|
|
"code":"44"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a permission policy.DELETE /v1/permissions/rules/{ruleid}NoneNoneNoneSee Error Codes.",
|
|
"product_code":"ucs",
|
|
"title":"Deleting a Permission Policy",
|
|
"uri":"DeleteRule.html",
|
|
"doc_type":"api",
|
|
"p_code":"42",
|
|
"code":"45"
|
|
},
|
|
{
|
|
"desc":"This API is used to update a permission policy.PUT /v1/permissions/rules/{ruleid}NoneUpdating a permission policyNoneSee Error Codes.",
|
|
"product_code":"ucs",
|
|
"title":"Updating a Permission Policy",
|
|
"uri":"UpdateRule.html",
|
|
"doc_type":"api",
|
|
"p_code":"42",
|
|
"code":"46"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"Appendix",
|
|
"uri":"ucs_api_0015.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"47"
|
|
},
|
|
{
|
|
"desc":"Normal valuesReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as ex",
|
|
"product_code":"ucs",
|
|
"title":"Status Codes",
|
|
"uri":"ucs_api_0016.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"48"
|
|
},
|
|
{
|
|
"desc":"If an exception occurs during the execution of an operation request and the request is not processed, an error message is returned. The error message contains the error c",
|
|
"product_code":"ucs",
|
|
"title":"Error Codes",
|
|
"uri":"ErrorCode.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"49"
|
|
},
|
|
{
|
|
"desc":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Call an API.Use the console",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining a Project ID",
|
|
"uri":"ucs_api_0018.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"50"
|
|
},
|
|
{
|
|
"desc":"An account ID is required for some URLs when an API is called. To obtain the account ID, perform the following steps:Register an account and log in to the management cons",
|
|
"product_code":"ucs",
|
|
"title":"Obtaining an Account ID",
|
|
"uri":"ucs_api_0019.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"51"
|
|
},
|
|
{
|
|
"desc":"AF: AfghanistanAL: AlbaniaDZ: AlgeriaAD: AndorraAO: AngolaAG: Antigua and BarbudaAR: ArgentinaAM: ArmeniaAU: AustraliaAT: AustriaAZ: AzerbaijanBS: BahamasBH: BahrainBD: B",
|
|
"product_code":"ucs",
|
|
"title":"Country Codes",
|
|
"uri":"ucs_api_0022.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"52"
|
|
},
|
|
{
|
|
"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":"ucs",
|
|
"title":"Cluster Categories and Types",
|
|
"uri":"ucs_api_0024.html",
|
|
"doc_type":"api",
|
|
"p_code":"47",
|
|
"code":"53"
|
|
}
|
|
] |