doc-exports/docs/cci/api-ref/CLASS.TXT.json
Dong, Qiu Jian 21dca87c32 CCI API initial upload
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
2024-10-14 11:16:04 +00:00

398 lines
15 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":"cci",
"title":"Calling APIs",
"uri":"cci_02_0009.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"Requests for calling an API can be authenticated using either of the following methods:AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authenticatio",
"product_code":"cci",
"title":"Authentication",
"uri":"cci_02_0003.html",
"doc_type":"api",
"p_code":"1",
"code":"2"
},
{
"desc":"You can call APIs to create a pod. An Nginx image is used as an example to show how you can create a pod.The Nginx image is from the open-source image center, and the con",
"product_code":"cci",
"title":"Getting Started",
"uri":"cci_02_0011.html",
"doc_type":"api",
"p_code":"",
"code":"3"
},
{
"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":"cci",
"title":"Proprietary APIs",
"uri":"cci_02_2000.html",
"doc_type":"api",
"p_code":"",
"code":"4"
},
{
"desc":"List or watch objects of kind Namespace.For details, see Calling APIs.GET /apis/cci/v2/namespacesStatus code: 200NoneStatus code: 200OKExample 1\"v1\"Example 2[ {\n \"apiVer",
"product_code":"cci",
"title":"Listing or Watching Objects of kind Namespace",
"uri":"listCciV2Namespace.html",
"doc_type":"api",
"p_code":"4",
"code":"5"
},
{
"desc":"Create a Namespace.A network must be created in a namespace to define the mapping between this network and a Virtual Private Cloud (VPC). For more information, see \"Names",
"product_code":"cci",
"title":"Creating a Namespace",
"uri":"createCciV2Namespace.html",
"doc_type":"api",
"p_code":"4",
"code":"6"
},
{
"desc":"Delete a Namespace.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{name}Status code: 200Status code: 202NoneStatus code: 200OKStatus code: 404",
"product_code":"cci",
"title":"Deleting a Namespace",
"uri":"deleteCciV2Namespace.html",
"doc_type":"api",
"p_code":"4",
"code":"7"
},
{
"desc":"Read the specified Namespace.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{name}Status code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Reading the Specified Namespace",
"uri":"readCciV2Namespace.html",
"doc_type":"api",
"p_code":"4",
"code":"8"
},
{
"desc":"List or watch objects of kind ConfigMap.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/configmapsStatus code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Listing or Watching Objects of kind ConfigMap",
"uri":"listCciV2NamespacedConfigMap.html",
"doc_type":"api",
"p_code":"4",
"code":"9"
},
{
"desc":"Create a ConfigMap.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/configmapsStatus code: 200Status code: 201Status code: 202Status code: 201Create",
"product_code":"cci",
"title":"Creating a ConfigMap",
"uri":"createCciV2NamespacedConfigMap.html",
"doc_type":"api",
"p_code":"4",
"code":"10"
},
{
"desc":"Delete a ConfigMap.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/configmaps/{name}Status code: 200Status code: 202NoneStatus code: 200OK",
"product_code":"cci",
"title":"Deleting a ConfigMap",
"uri":"deleteCciV2NamespacedConfigMap.html",
"doc_type":"api",
"p_code":"4",
"code":"11"
},
{
"desc":"Read the specified ConfigMap.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/configmaps/{name}Status code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Reading the Specified ConfigMap",
"uri":"readCciV2NamespacedConfigMap.html",
"doc_type":"api",
"p_code":"4",
"code":"12"
},
{
"desc":"Replace the specified ConfigMap.The following fields can be updated:metadata.labelsmetadata.annotationsdataFor details, see Calling APIs.PUT /apis/cci/v2/namespaces/{name",
"product_code":"cci",
"title":"Replacing the Specified ConfigMap",
"uri":"replaceCciV2NamespacedConfigMap.html",
"doc_type":"api",
"p_code":"4",
"code":"13"
},
{
"desc":"List or watch objects of kind Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/podsStatus code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Listing or Watching Objects of kind Pod",
"uri":"listCciV2NamespacedPod.html",
"doc_type":"api",
"p_code":"4",
"code":"14"
},
{
"desc":"Create a Pod.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/podsStatus code: 200Status code: 201Status code: 202Status code: 201Created",
"product_code":"cci",
"title":"Creating a Pod",
"uri":"createCciV2NamespacedPod.html",
"doc_type":"api",
"p_code":"4",
"code":"15"
},
{
"desc":"Delete a Pod.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/pods/{name}Status code: 200Status code: 202NoneStatus code: 200OK",
"product_code":"cci",
"title":"Deleting a Pod",
"uri":"deleteCciV2NamespacedPod.html",
"doc_type":"api",
"p_code":"4",
"code":"16"
},
{
"desc":"Read the specified Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}Status code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Reading the Specified Pod",
"uri":"readCciV2NamespacedPod.html",
"doc_type":"api",
"p_code":"4",
"code":"17"
},
{
"desc":"Partially update the specified Pod.The following fields can be updated:metadata.generateNamemetadata.labelsmetadata.annotationsspec.initContainers[*].imagespec.containers",
"product_code":"cci",
"title":"Partially Updating the Specified Pod",
"uri":"patchCciV2NamespacedPod.html",
"doc_type":"api",
"p_code":"4",
"code":"18"
},
{
"desc":"Replace the specified Pod.The following fields can be updated:metadata.labelsmetadata.annotationsspec.initContainers[*].imagespec.containers[*].imagespec.activeDeadlineSe",
"product_code":"cci",
"title":"Replacing the Specified Pod",
"uri":"replaceCciV2NamespacedPod.html",
"doc_type":"api",
"p_code":"4",
"code":"19"
},
{
"desc":"Connect GET requests to exec of Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/execStatus code: 200NoneNone",
"product_code":"cci",
"title":"Connecting GET Requests to exec of Pod",
"uri":"connectCciV2GetNamespacedPodExec.html",
"doc_type":"api",
"p_code":"4",
"code":"20"
},
{
"desc":"Connect POST requests to exec of Pod.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/pods/{name}/execStatus code: 200NoneNone",
"product_code":"cci",
"title":"Connecting POST Requests to exec of Pod",
"uri":"connectCciV2PostNamespacedPodExec.html",
"doc_type":"api",
"p_code":"4",
"code":"21"
},
{
"desc":"Read logs of the specified Pod.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/pods/{name}/logStatus code: 200NoneNone",
"product_code":"cci",
"title":"Reading Logs of the Specified Pod",
"uri":"readCciV2NamespacedPodLog.html",
"doc_type":"api",
"p_code":"4",
"code":"22"
},
{
"desc":"List or watch objects of kind Secret.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/secretsStatus code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Listing or Watching Objects of kind Secret",
"uri":"listCciV2NamespacedSecret.html",
"doc_type":"api",
"p_code":"4",
"code":"23"
},
{
"desc":"Create a Secret.For details, see Calling APIs.POST /apis/cci/v2/namespaces/{namespace}/secretsStatus code: 200Status code: 201Status code: 202Status code: 201Created",
"product_code":"cci",
"title":"Creating a Secret",
"uri":"createCciV2NamespacedSecret.html",
"doc_type":"api",
"p_code":"4",
"code":"24"
},
{
"desc":"Delete a Secret.For details, see Calling APIs.DELETE /apis/cci/v2/namespaces/{namespace}/secrets/{name}Status code: 200Status code: 202NoneStatus code: 200OK",
"product_code":"cci",
"title":"Deleting a Secret",
"uri":"deleteCciV2NamespacedSecret.html",
"doc_type":"api",
"p_code":"4",
"code":"25"
},
{
"desc":"Read the specified Secret.For details, see Calling APIs.GET /apis/cci/v2/namespaces/{namespace}/secrets/{name}Status code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Reading the Specified Secret",
"uri":"readCciV2NamespacedSecret.html",
"doc_type":"api",
"p_code":"4",
"code":"26"
},
{
"desc":"Replace the specified Secret.The following fields can be updated:metadata.labelsmetadata.annotationsdataIf type is set to Opaque, the key and value of data can be updated",
"product_code":"cci",
"title":"Replacing the Specified Secret",
"uri":"replaceCciV2NamespacedSecret.html",
"doc_type":"api",
"p_code":"4",
"code":"27"
},
{
"desc":"List or watch objects of kind Network.For details, see Calling APIs.GET /apis/yangtse/v2/namespaces/{namespace}/networksStatus code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Listing or Watching Objects of kind Network",
"uri":"listYangtseV2NamespacedNetwork.html",
"doc_type":"api",
"p_code":"4",
"code":"28"
},
{
"desc":"Create a Network.For details, see Calling APIs.POST /apis/yangtse/v2/namespaces/{namespace}/networksStatus code: 200Status code: 201Status code: 202Status code: 201Create",
"product_code":"cci",
"title":"Creating a Network",
"uri":"createYangtseV2NamespacedNetwork.html",
"doc_type":"api",
"p_code":"4",
"code":"29"
},
{
"desc":"Delete a Network.For details, see Calling APIs.DELETE /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200Status code: 202NoneStatus code: 200OK",
"product_code":"cci",
"title":"Deleting a Network",
"uri":"deleteYangtseV2NamespacedNetwork.html",
"doc_type":"api",
"p_code":"4",
"code":"30"
},
{
"desc":"Read the specified Network.For details, see Calling APIs.GET /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200NoneStatus code: 200OK",
"product_code":"cci",
"title":"Reading the Specified Network",
"uri":"readYangtseV2NamespacedNetwork.html",
"doc_type":"api",
"p_code":"4",
"code":"31"
},
{
"desc":"Replace the specified Network.For details, see Calling APIs.PUT /apis/yangtse/v2/namespaces/{namespace}/networks/{name}Status code: 200Status code: 201Status code: 200OK",
"product_code":"cci",
"title":"Replacing the Specified Network",
"uri":"replaceYangtseV2NamespacedNetwork.html",
"doc_type":"api",
"p_code":"4",
"code":"32"
},
{
"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":"cci",
"title":"Permissions Policies and Supported Actions",
"uri":"cci_02_0082.html",
"doc_type":"api",
"p_code":"",
"code":"33"
},
{
"desc":"This topic describes fine-grained permissions management for your CCI. If your account does not need individual IAM users, you may skip this topic.You need to add a user ",
"product_code":"cci",
"title":"Introduction",
"uri":"cci_02_0081.html",
"doc_type":"api",
"p_code":"33",
"code":"34"
},
{
"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":"cci",
"title":"Category of CCI Actions",
"uri":"cci_02_0083.html",
"doc_type":"api",
"p_code":"33",
"code":"35"
},
{
"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":"cci",
"title":"Appendix",
"uri":"cci_02_0067.html",
"doc_type":"api",
"p_code":"",
"code":"36"
},
{
"desc":"CCI is available in regions listed in Table 1.",
"product_code":"cci",
"title":"Notes and Constraints",
"uri":"pro_ys.html",
"doc_type":"api",
"p_code":"36",
"code":"37"
},
{
"desc":"A namespace provides a method of allocating resources among multiple users. It applies to scenarios where multiple teams or projects exist.A network is a Kubernetes resou",
"product_code":"cci",
"title":"Namespace and Network",
"uri":"devg_na.html",
"doc_type":"api",
"p_code":"36",
"code":"38"
},
{
"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":"cci",
"title":"Status Codes",
"uri":"cci_02_0068.html",
"doc_type":"api",
"p_code":"36",
"code":"39"
},
{
"desc":"If an error occurs in API calling, no result is returned. Identify the error cause based on the error codes of each API. If an error occurs in API calling, HTTP status co",
"product_code":"cci",
"title":"Error Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
"p_code":"36",
"code":"40"
},
{
"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:Obtain the Project ID by Ca",
"product_code":"cci",
"title":"Obtaining a Project ID",
"uri":"cci_02_1001.html",
"doc_type":"api",
"p_code":"36",
"code":"41"
},
{
"desc":"An account ID (domain ID) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:Log in to the management console.Clic",
"product_code":"cci",
"title":"Obtaining an Account ID",
"uri":"cci_02_1002.html",
"doc_type":"api",
"p_code":"36",
"code":"42"
},
{
"desc":"Cloud Container Instance (CCI) supports both images in the container registry and those uploaded to SoftWare Repository for Container (SWR). Where,SWR has synchronized so",
"product_code":"cci",
"title":"Obtaining a Container Image Address",
"uri":"cci_02_1003.html",
"doc_type":"api",
"p_code":"36",
"code":"43"
},
{
"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":"cci",
"title":"Change History",
"uri":"en-us_topic_0000001991313061.html",
"doc_type":"api",
"p_code":"",
"code":"44"
}
]