forked from docs/doc-exports
CSS API 20230223 Version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
This commit is contained in:
parent
6edd5bfe3a
commit
c8d7a6f7c1
@ -33,7 +33,7 @@
|
|||||||
"uri":"css_03_0056.html",
|
"uri":"css_03_0056.html",
|
||||||
"product_code":"css",
|
"product_code":"css",
|
||||||
"code":"4",
|
"code":"4",
|
||||||
"des":"In CSS, Elasticsearch 7.6.2 and 7.9.3 and Kibana 7.6.2 and 7.9.3 are supported.",
|
"des":"In CSS, Elasticsearch 7.6.2, 7.9.3 and 7.10.2 and Kibana 7.6.2, 7.9.3 and 7.10.2 are supported.",
|
||||||
"doc_type":"api",
|
"doc_type":"api",
|
||||||
"kw":"Supported Cluster Versions,Before You Start,API Reference",
|
"kw":"Supported Cluster Versions,Before You Start,API Reference",
|
||||||
"title":"Supported Cluster Versions",
|
"title":"Supported Cluster Versions",
|
||||||
@ -369,30 +369,10 @@
|
|||||||
"title":"Obtaining a Project ID and Name",
|
"title":"Obtaining a Project ID and Name",
|
||||||
"githuburl":""
|
"githuburl":""
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"uri":"css_03_0073.html",
|
|
||||||
"product_code":"css",
|
|
||||||
"code":"38",
|
|
||||||
"des":"Table 1 describes the common request parameters.",
|
|
||||||
"doc_type":"api",
|
|
||||||
"kw":"Common Request Parameters,Common Parameters,API Reference",
|
|
||||||
"title":"Common Request Parameters",
|
|
||||||
"githuburl":""
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"uri":"css_03_0074.html",
|
|
||||||
"product_code":"css",
|
|
||||||
"code":"39",
|
|
||||||
"des":"Table 1 describes common response headers.",
|
|
||||||
"doc_type":"api",
|
|
||||||
"kw":"Common Response Parameters,Common Parameters,API Reference",
|
|
||||||
"title":"Common Response Parameters",
|
|
||||||
"githuburl":""
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"uri":"css_03_0075.html",
|
"uri":"css_03_0075.html",
|
||||||
"product_code":"css",
|
"product_code":"css",
|
||||||
"code":"40",
|
"code":"38",
|
||||||
"des":"Table 1 describes the status code.",
|
"des":"Table 1 describes the status code.",
|
||||||
"doc_type":"api",
|
"doc_type":"api",
|
||||||
"kw":"Status Code,Common Parameters,API Reference",
|
"kw":"Status Code,Common Parameters,API Reference",
|
||||||
@ -402,7 +382,7 @@
|
|||||||
{
|
{
|
||||||
"uri":"css_03_0076.html",
|
"uri":"css_03_0076.html",
|
||||||
"product_code":"css",
|
"product_code":"css",
|
||||||
"code":"41",
|
"code":"39",
|
||||||
"des":"No data is returned if an API fails to be invoked. You can locate the cause of an error according to the error code of each API. When the API calling fails, HTTPS status ",
|
"des":"No data is returned if an API fails to be invoked. You can locate the cause of an error according to the error code of each API. When the API calling fails, HTTPS status ",
|
||||||
"doc_type":"api",
|
"doc_type":"api",
|
||||||
"kw":"Error Code,Common Parameters,API Reference",
|
"kw":"Error Code,Common Parameters,API Reference",
|
||||||
@ -412,7 +392,7 @@
|
|||||||
{
|
{
|
||||||
"uri":"css_03_0024.html",
|
"uri":"css_03_0024.html",
|
||||||
"product_code":"css",
|
"product_code":"css",
|
||||||
"code":"42",
|
"code":"40",
|
||||||
"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.",
|
"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",
|
"doc_type":"api",
|
||||||
"kw":"Change History,API Reference",
|
"kw":"Change History,API Reference",
|
||||||
|
@ -27,7 +27,7 @@
|
|||||||
"code":"3"
|
"code":"3"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"desc":"In CSS, Elasticsearch 7.6.2 and 7.9.3 and Kibana 7.6.2 and 7.9.3 are supported.",
|
"desc":"In CSS, Elasticsearch 7.6.2, 7.9.3 and 7.10.2 and Kibana 7.6.2, 7.9.3 and 7.10.2 are supported.",
|
||||||
"product_code":"css",
|
"product_code":"css",
|
||||||
"title":"Supported Cluster Versions",
|
"title":"Supported Cluster Versions",
|
||||||
"uri":"css_03_0056.html",
|
"uri":"css_03_0056.html",
|
||||||
@ -332,24 +332,6 @@
|
|||||||
"p_code":"36",
|
"p_code":"36",
|
||||||
"code":"37"
|
"code":"37"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"desc":"Table 1 describes the common request parameters.",
|
|
||||||
"product_code":"css",
|
|
||||||
"title":"Common Request Parameters",
|
|
||||||
"uri":"css_03_0073.html",
|
|
||||||
"doc_type":"api",
|
|
||||||
"p_code":"36",
|
|
||||||
"code":"38"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"desc":"Table 1 describes common response headers.",
|
|
||||||
"product_code":"css",
|
|
||||||
"title":"Common Response Parameters",
|
|
||||||
"uri":"css_03_0074.html",
|
|
||||||
"doc_type":"api",
|
|
||||||
"p_code":"36",
|
|
||||||
"code":"39"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"desc":"Table 1 describes the status code.",
|
"desc":"Table 1 describes the status code.",
|
||||||
"product_code":"css",
|
"product_code":"css",
|
||||||
@ -357,7 +339,7 @@
|
|||||||
"uri":"css_03_0075.html",
|
"uri":"css_03_0075.html",
|
||||||
"doc_type":"api",
|
"doc_type":"api",
|
||||||
"p_code":"36",
|
"p_code":"36",
|
||||||
"code":"40"
|
"code":"38"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"desc":"No data is returned if an API fails to be invoked. You can locate the cause of an error according to the error code of each API. When the API calling fails, HTTPS status ",
|
"desc":"No data is returned if an API fails to be invoked. You can locate the cause of an error according to the error code of each API. When the API calling fails, HTTPS status ",
|
||||||
@ -366,7 +348,7 @@
|
|||||||
"uri":"css_03_0076.html",
|
"uri":"css_03_0076.html",
|
||||||
"doc_type":"api",
|
"doc_type":"api",
|
||||||
"p_code":"36",
|
"p_code":"36",
|
||||||
"code":"41"
|
"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.",
|
"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.",
|
||||||
@ -375,6 +357,6 @@
|
|||||||
"uri":"css_03_0024.html",
|
"uri":"css_03_0024.html",
|
||||||
"doc_type":"api",
|
"doc_type":"api",
|
||||||
"p_code":"",
|
"p_code":"",
|
||||||
"code":"42"
|
"code":"40"
|
||||||
}
|
}
|
||||||
]
|
]
|
@ -217,13 +217,6 @@
|
|||||||
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p2805125783010">Tags of a cluster.</p>
|
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p2805125783010">Tags of a cluster.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0018__row19220161012204"><td class="cellrowborder" valign="top" width="25.353535353535356%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0018__p132201810182014">period</p>
|
|
||||||
</td>
|
|
||||||
<td class="cellrowborder" valign="top" width="26.202020202020204%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0018__p1221191022019">Boolean</p>
|
|
||||||
</td>
|
|
||||||
<td class="cellrowborder" valign="top" width="48.44444444444444%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0018__p154111215401">Whether the cluster is billed.</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
@ -247,7 +240,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="25.1025102510251%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0018__p16151201913437">String</p>
|
<td class="cellrowborder" valign="top" width="25.1025102510251%" headers="mcps1.3.4.5.2.4.1.2 "><p id="css_03_0018__p16151201913437">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="49.27492749274928%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0018__p8151191912439">Engine version number. </p>
|
<td class="cellrowborder" valign="top" width="49.27492749274928%" headers="mcps1.3.4.5.2.4.1.3 "><p id="css_03_0018__p8151191912439">Engine version number.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -389,7 +382,7 @@
|
|||||||
"id": "c8c90973-924d-4201-b9ff-f32279c87d0e",
|
"id": "c8c90973-924d-4201-b9ff-f32279c87d0e",
|
||||||
"name": "css-5492-ess-esn-1-1",
|
"name": "css-5492-ess-esn-1-1",
|
||||||
"specCode": "css.xlarge.2",
|
"specCode": "css.xlarge.2",
|
||||||
"azCode": "cn-cmcc1a-01"
|
"azCode": "eu-de-01"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"updated": "2020-12-01T07:47:34",
|
"updated": "2020-12-01T07:47:34",
|
||||||
@ -407,13 +400,12 @@
|
|||||||
"cmkId": "00f05033-f8ac-4ceb-a1ce-4072fadb6b28",
|
"cmkId": "00f05033-f8ac-4ceb-a1ce-4072fadb6b28",
|
||||||
"actionProgress": {},
|
"actionProgress": {},
|
||||||
"actions": [],
|
"actions": [],
|
||||||
"tags": [],
|
"tags": []
|
||||||
"period": false
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"datastore": {
|
"datastore": {
|
||||||
"type": "elasticsearch",
|
"type": "elasticsearch",
|
||||||
"version": "6.2.3"
|
"version": "7.6.2"
|
||||||
},
|
},
|
||||||
"instances": [
|
"instances": [
|
||||||
{
|
{
|
||||||
@ -422,7 +414,7 @@
|
|||||||
"id": "a24adddb-1553-4873-9978-9d064418f903",
|
"id": "a24adddb-1553-4873-9978-9d064418f903",
|
||||||
"name": "css-1d01-ess-esn-1-1",
|
"name": "css-1d01-ess-esn-1-1",
|
||||||
"specCode": "css.xlarge.2",
|
"specCode": "css.xlarge.2",
|
||||||
"azCode": "cn-cmcc1a-01"
|
"azCode": "eu-de-01"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"updated": "2020-11-26T10:08:44",
|
"updated": "2020-11-26T10:08:44",
|
||||||
@ -440,8 +432,7 @@
|
|||||||
"cmkId": "",
|
"cmkId": "",
|
||||||
"actionProgress": {},
|
"actionProgress": {},
|
||||||
"actions": [],
|
"actions": [],
|
||||||
"tags": [],
|
"tags": []
|
||||||
"period": false
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"datastore": {
|
"datastore": {
|
||||||
@ -455,7 +446,7 @@
|
|||||||
"id": "071c7ecf-a11d-45bd-9564-201ceb7cfae3",
|
"id": "071c7ecf-a11d-45bd-9564-201ceb7cfae3",
|
||||||
"name": "css-9b36-ess-esn-1-1",
|
"name": "css-9b36-ess-esn-1-1",
|
||||||
"specCode": "css.xlarge.2",
|
"specCode": "css.xlarge.2",
|
||||||
"azCode": "cn-cmcc1b-01"
|
"azCode": "eu-de-01"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"updated": "2020-11-13T14:33:24",
|
"updated": "2020-11-13T14:33:24",
|
||||||
@ -473,8 +464,7 @@
|
|||||||
"cmkId": "",
|
"cmkId": "",
|
||||||
"actionProgress": {},
|
"actionProgress": {},
|
||||||
"actions": [],
|
"actions": [],
|
||||||
"tags": [],
|
"tags": []
|
||||||
"period": false
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}</pre>
|
}</pre>
|
||||||
|
@ -125,8 +125,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="13.686868686868689%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p13340174115126">String</p>
|
<td class="cellrowborder" valign="top" width="13.686868686868689%" headers="mcps1.3.3.4.2.5.1.3 "><p id="css_03_0019__p13340174115126">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p434054111210">Whether communication is encrypted on the cluster. Available values include <strong id="css_03_0019__b3595124913285">true</strong> and <strong id="css_03_0019__b1960114516289">false</strong>. By default, communication is encrypted.</p>
|
<td class="cellrowborder" valign="top" width="50.474747474747474%" headers="mcps1.3.3.4.2.5.1.4 "><p id="css_03_0019__p143105781314">Whether communication encryption is performed on the cluster. Available values include <strong id="css_03_0019__b1531037101315">true</strong> and <strong id="css_03_0019__b1331013761315">false</strong>. By default, communication encryption is disabled. When <strong id="css_03_0019__b12310137131312">httpsEnable</strong> is set to <strong id="css_03_0019__b163111978139">true</strong>, <strong id="css_03_0019__b431114711310">authorityEnable</strong> must be set to <strong id="css_03_0019__b183117715139">true</strong>.</p>
|
||||||
<ul id="css_03_0019__ul1620016015114"><li id="css_03_0019__li92011706518">Value <strong id="css_03_0019__b67881516192918">true</strong> indicates that communication is encrypted on the cluster.</li><li id="css_03_0019__li154532024513">Value <strong id="css_03_0019__b740663482913">false</strong> indicates that communication is not encrypted on the cluster.</li></ul>
|
<ul id="css_03_0019__ul1731118710136"><li id="css_03_0019__li1731197111312">Value <strong id="css_03_0019__b931119713135">true</strong> indicates that communication encryption is performed on the cluster.</li><li id="css_03_0019__li183118731314">Value <strong id="css_03_0019__b431110710131">false</strong> indicates that communication encryption is not performed on the cluster.</li></ul>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0019__row15589103810285"><td class="cellrowborder" valign="top" width="18.03030303030303%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p18589938102815">authorityEnable</p>
|
<tr id="css_03_0019__row15589103810285"><td class="cellrowborder" valign="top" width="18.03030303030303%" headers="mcps1.3.3.4.2.5.1.1 "><p id="css_03_0019__p18589938102815">authorityEnable</p>
|
||||||
@ -207,6 +207,17 @@
|
|||||||
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.5.2.5.1.4 "><p id="css_03_0019__p19114171413565">Subnet information. For details about related parameters, see <a href="#css_03_0019__table1959831319562">Table 6</a>.</p>
|
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.5.2.5.1.4 "><p id="css_03_0019__p19114171413565">Subnet information. For details about related parameters, see <a href="#css_03_0019__table1959831319562">Table 6</a>.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr id="css_03_0019__row1471028164115"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.5.2.5.1.1 "><p id="css_03_0019__p1641339204112">availability_zone</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.5.2.5.1.2 "><p id="css_03_0019__p17641239194115">No</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.5.2.5.1.3 "><p id="css_03_0019__p5641339154116">String</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="57.42574257425742%" headers="mcps1.3.3.5.2.5.1.4 "><p id="css_03_0019__p184186269549">Availability zone (AZ). A single AZ is created when this parameter is not specified.</p>
|
||||||
|
<p id="css_03_0019__p27594571757">Separate multiple AZs with commas (,), for example, <strong id="css_03_0019__b105526475443">az1,az2</strong>. AZs must be unique and ensure that the number of nodes be at least the number of AZs.</p>
|
||||||
|
<p id="css_03_0019__p106211606349">If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ. If the number of nodes is not a multiple of the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
@ -335,7 +346,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="12.590000000000002%" headers="mcps1.3.3.9.2.5.1.3 "><p id="css_03_0019__p10686165912114">String</p>
|
<td class="cellrowborder" valign="top" width="12.590000000000002%" headers="mcps1.3.3.9.2.5.1.3 "><p id="css_03_0019__p10686165912114">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="56.71000000000001%" headers="mcps1.3.3.9.2.5.1.4 "><p id="css_03_0019__p284353717266">Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, <span class="parmname" id="css_03_0019__parmname207181910155010"><b>HH:mm z</b></span>. In the format, <span class="parmname" id="css_03_0019__parmname26580719510"><b>HH:mm</b></span> refers to the hour time and <span class="parmname" id="css_03_0019__parmname12640155145015"><b>z</b></span> refers to the time zone, for example, <span class="parmvalue" id="css_03_0019__parmvalue150123314505"><b>00:00 GMT+08:00</b></span> and <span class="parmvalue" id="css_03_0019__parmvalue1695214431503"><b>01:00 GMT+08:00</b></span>.</p>
|
<td class="cellrowborder" valign="top" width="56.71000000000001%" headers="mcps1.3.3.9.2.5.1.4 "><p id="css_03_0019__p284353717266">Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, <span class="parmname" id="css_03_0019__parmname207181910155010"><b>HH:mm z</b></span>. In the format, <span class="parmname" id="css_03_0019__parmname26580719510"><b>HH:mm</b></span> refers to the hour time and <span class="parmname" id="css_03_0019__parmname12640155145015"><b>z</b></span> refers to the time zone, for example, <span class="parmvalue" id="css_03_0019__parmvalue150123314505"><b>00:00 GMT+08:00</b></span> and <span class="parmvalue" id="css_03_0019__parmvalue1695214431503"><b>01:00 GMT+02:00</b></span>.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0019__row66931659202111"><td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.3.9.2.5.1.1 "><p id="css_03_0019__p0694195919216">prefix</p>
|
<tr id="css_03_0019__row66931659202111"><td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.3.9.2.5.1.1 "><p id="css_03_0019__p0694195919216">prefix</p>
|
||||||
@ -509,7 +520,8 @@
|
|||||||
"name": "ES-Test",
|
"name": "ES-Test",
|
||||||
"instanceNum": 4,
|
"instanceNum": 4,
|
||||||
"instance": {
|
"instance": {
|
||||||
"flavorRef": "css.large.8",
|
"availability_zone": "eu-de-01",
|
||||||
|
"flavorRef": "css.large.8",
|
||||||
"volume": {
|
"volume": {
|
||||||
"volume_type": "COMMON",
|
"volume_type": "COMMON",
|
||||||
"size": 100
|
"size": 100
|
||||||
|
@ -144,7 +144,7 @@
|
|||||||
<pre class="screen" id="css_03_0023__screen491757623">{
|
<pre class="screen" id="css_03_0023__screen491757623">{
|
||||||
"versions": [
|
"versions": [
|
||||||
{
|
{
|
||||||
"version": "6.2.3",
|
"version": "7.6.2",
|
||||||
"flavors": [
|
"flavors": [
|
||||||
{
|
{
|
||||||
"cpu": 1,
|
"cpu": 1,
|
||||||
|
@ -8,7 +8,23 @@
|
|||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody><tr id="css_03_0024__row6818133117347"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p6818531133419">2022-06-30</p>
|
<tbody><tr id="css_03_0024__row171211401282"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p17311134813819">2023-02-23</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><p id="css_03_0024__p126391541291"><span style="color:#252B3A;">Optimized the parameter description in</span>: <a href="css_03_0019.html">Creating a Cluster</a></p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="css_03_0024__row1969612109405"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p1584891634012">2022-09-14</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><p id="css_03_0024__p12676159153813">Updated:</p>
|
||||||
|
<ul id="css_03_0024__ul132109457388"><li id="css_03_0024__li1211184519382"><a href="css_03_0019.html">Creating a Cluster</a></li><li id="css_03_0024__li384414201883"><a href="css_03_0018.html">Querying the List of Clusters</a></li><li id="css_03_0024__li1634025115817"><a href="css_03_0026.html">Querying Cluster Details</a></li><li id="css_03_0024__li164741016395"><a href="css_03_0031.html">Setting the Automatic Snapshot Creation Policy</a></li><li id="css_03_0024__li3116141117399"><a href="css_03_0032.html">Querying the Automatic Snapshot Creation Policy for a Cluster</a></li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="css_03_0024__row16558121992212"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p1655821912210">2022-07-28</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul4517133245212"><li id="css_03_0024__li1061343610524">Added <span class="uicontrol" id="css_03_0024__uicontrol2166161418209"><b>Common Request Parameters</b></span> and <span class="uicontrol" id="css_03_0024__uicontrol15407142314208"><b>Common Response Parameters </b></span> in <a href="iam_01_0023.html">Calling APIs</a>.</li><li id="css_03_0024__li17517113210526">Added cluster version 7.10.2.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="css_03_0024__row6818133117347"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p6818531133419">2022-06-30</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul436719111371"><li id="css_03_0024__li1936831123712">Optimized API calling methods:<ul id="css_03_0024__ul1736813112374"><li id="css_03_0024__li193681914376"><a href="iam_01_0023.html">Calling APIs</a></li></ul>
|
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul436719111371"><li id="css_03_0024__li1936831123712">Optimized API calling methods:<ul id="css_03_0024__ul1736813112374"><li id="css_03_0024__li193681914376"><a href="iam_01_0023.html">Calling APIs</a></li></ul>
|
||||||
</li><li id="css_03_0024__li336815163710">Optimized common contents:<ul id="css_03_0024__ul93681112375"><li id="css_03_0024__li1736819133710"><a href="css_03_0056.html">Supported Cluster Versions</a></li><li id="css_03_0024__li1736811183710"><a href="css_03_0071.html">Obtaining a Project ID and Name</a></li></ul>
|
</li><li id="css_03_0024__li336815163710">Optimized common contents:<ul id="css_03_0024__ul93681112375"><li id="css_03_0024__li1736819133710"><a href="css_03_0056.html">Supported Cluster Versions</a></li><li id="css_03_0024__li1736811183710"><a href="css_03_0071.html">Obtaining a Project ID and Name</a></li></ul>
|
||||||
@ -119,7 +135,7 @@
|
|||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0024__row16397182015585"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p339722017584">2018-09-29</p>
|
<tr id="css_03_0024__row16397182015585"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p339722017584">2018-09-29</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul1167338151012"><li id="css_03_0024__li667314871010">Modified the parameter description in the following sections:<ul id="css_03_0024__ul10673083101"><li id="css_03_0024__li146733881020"><a href="css_03_0019.html">Creating a Cluster</a></li><li id="css_03_0024__li1867311821020">CSS Monitoring Metrics</li><li id="css_03_0024__li11673188201018"><a href="css_03_0073.html">Common Request Parameters</a></li></ul>
|
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul1167338151012"><li id="css_03_0024__li667314871010">Modified the parameter description in the following sections:<ul id="css_03_0024__ul10673083101"><li id="css_03_0024__li146733881020"><a href="css_03_0019.html">Creating a Cluster</a></li><li id="css_03_0024__li1867311821020">CSS Monitoring Metrics</li><li id="css_03_0024__li11673188201018">Common Request Parameters</li></ul>
|
||||||
</li><li id="css_03_0024__li98892281013">Deleted information related to the <span class="parmname" id="css_03_0024__parmname26611601492"><b>extendparam</b></span> parameter and modified the example response.<p id="css_03_0024__p19725173919107"><a href="css_03_0033.html">Manually Creating a Snapshot</a></p>
|
</li><li id="css_03_0024__li98892281013">Deleted information related to the <span class="parmname" id="css_03_0024__parmname26611601492"><b>extendparam</b></span> parameter and modified the example response.<p id="css_03_0024__p19725173919107"><a href="css_03_0033.html">Manually Creating a Snapshot</a></p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
</td>
|
</td>
|
||||||
@ -146,8 +162,8 @@
|
|||||||
</li><li id="css_03_0024__li0124712102113">Modified the example response. Added the status code returned by the API for deleting a cluster.<p id="css_03_0024__p62081810194816"><a name="css_03_0024__li0124712102113"></a><a name="li0124712102113"></a><a href="css_03_0020.html">Deleting a Cluster</a></p>
|
</li><li id="css_03_0024__li0124712102113">Modified the example response. Added the status code returned by the API for deleting a cluster.<p id="css_03_0024__p62081810194816"><a name="css_03_0024__li0124712102113"></a><a name="li0124712102113"></a><a href="css_03_0020.html">Deleting a Cluster</a></p>
|
||||||
</li><li id="css_03_0024__li1972175011203">Modified the URI format. Added the status code returned by the API for obtaining the list of instance flavors.<p id="css_03_0024__p1617914401292"><a name="css_03_0024__li1972175011203"></a><a name="li1972175011203"></a><a href="css_03_0023.html">Obtaining the List of Instance Flavors</a></p>
|
</li><li id="css_03_0024__li1972175011203">Modified the URI format. Added the status code returned by the API for obtaining the list of instance flavors.<p id="css_03_0024__p1617914401292"><a name="css_03_0024__li1972175011203"></a><a name="li1972175011203"></a><a href="css_03_0023.html">Obtaining the List of Instance Flavors</a></p>
|
||||||
</li><li id="css_03_0024__li6279448172013">Modified the function description. Modify the example request. Added the status code returned by the API for automatically performing basic configurations for a cluster snapshot.<p id="css_03_0024__p19190171015481"><a name="css_03_0024__li6279448172013"></a><a name="li6279448172013"></a><a href="css_03_0037.html">(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot</a></p>
|
</li><li id="css_03_0024__li6279448172013">Modified the function description. Modify the example request. Added the status code returned by the API for automatically performing basic configurations for a cluster snapshot.<p id="css_03_0024__p19190171015481"><a name="css_03_0024__li6279448172013"></a><a name="li6279448172013"></a><a href="css_03_0037.html">(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot</a></p>
|
||||||
</li><li id="css_03_0024__li20675126182218">Modified the description about the <span class="parmname" id="css_03_0024__parmname363212532093"><b>indices</b></span> parameter in the request parameter table. Changed parameter names <span class="parmname"><b>bakExpectedStartTime</b></span>, <span class="parmname"><b>bakKeepDay</b></span>, and <span class="parmname"><b>bakPeriod</b></span> in the table of <strong>backup</strong> field data structure description to <strong>backupExpectedStartTime</strong>, <strong>backupKeepDay</strong>, and <strong>backupPeriod</strong>, respectively. Modified the example response. Added the status code returned by the API for manually creating a cluster snapshot.<p id="css_03_0024__p999219285565"><a href="css_03_0033.html">Manually Creating a Snapshot</a></p>
|
</li><li id="css_03_0024__li20675126182218">Modified the description about the <span class="parmname" id="css_03_0024__parmname363212532093"><b>indices</b></span> parameter in the request parameter table. Changed parameter names <span class="parmname" id="css_03_0024__parmname9692191672219"><b>bakExpectedStartTime</b></span>, <span class="parmname" id="css_03_0024__parmname19692716162215"><b>bakKeepDay</b></span>, and <span class="parmname" id="css_03_0024__parmname169216169222"><b>bakPeriod</b></span> in the table of <strong id="css_03_0024__b1869251642216">backup</strong> field data structure description to <strong id="css_03_0024__b6692616202217">backupExpectedStartTime</strong>, <strong id="css_03_0024__b66921516122218">backupKeepDay</strong>, and <strong id="css_03_0024__b46921916142210">backupPeriod</strong>, respectively. Modified the example response. Added the status code returned by the API for manually creating a cluster snapshot.<p id="css_03_0024__p999219285565"><a href="css_03_0033.html">Manually Creating a Snapshot</a></p>
|
||||||
</li><li id="css_03_0024__li1538674616208">Changed parameter names <span class="parmname"><b>bakExpectedStartTime</b></span>, <span class="parmname"><b>bakKeepDay</b></span>, and <span class="parmname"><b>bakPeriod</b></span> in the table of <strong>backups</strong> field data structure description to <strong>backupExpectedStartTime</strong>, <strong>backupKeepDay</strong>, and <strong>backupPeriod</strong>, respectively. Modified the example response. Added the status code returned by the API for querying the list of snapshots.<p id="css_03_0024__p183581454143119"><a href="css_03_0034.html">Querying the List of Snapshots</a></p>
|
</li><li id="css_03_0024__li1538674616208">Changed parameter names <span class="parmname" id="css_03_0024__parmname4692516202220"><b>bakExpectedStartTime</b></span>, <span class="parmname" id="css_03_0024__parmname18692916162210"><b>bakKeepDay</b></span>, and <span class="parmname" id="css_03_0024__parmname6692916172214"><b>bakPeriod</b></span> in the table of <strong id="css_03_0024__b176925167221">backups</strong> field data structure description to <strong id="css_03_0024__b156921516112220">backupExpectedStartTime</strong>, <strong id="css_03_0024__b1069261662217">backupKeepDay</strong>, and <strong id="css_03_0024__b869221662212">backupPeriod</strong>, respectively. Modified the example response. Added the status code returned by the API for querying the list of snapshots.<p id="css_03_0024__p183581454143119"><a href="css_03_0034.html">Querying the List of Snapshots</a></p>
|
||||||
</li><li id="css_03_0024__li9799616202416">Modified the description in the request parameter table. Added the status code returned by the API for restoring snapshots.<p id="css_03_0024__p2335101732410"><a name="css_03_0024__li9799616202416"></a><a name="li9799616202416"></a><a href="css_03_0035.html">Restoring a Snapshot</a></p>
|
</li><li id="css_03_0024__li9799616202416">Modified the description in the request parameter table. Added the status code returned by the API for restoring snapshots.<p id="css_03_0024__p2335101732410"><a name="css_03_0024__li9799616202416"></a><a name="li9799616202416"></a><a href="css_03_0035.html">Restoring a Snapshot</a></p>
|
||||||
</li><li id="css_03_0024__li1187082172416">Added the handling method for each error code.</li></ul>
|
</li><li id="css_03_0024__li1187082172416">Added the handling method for each error code.</li></ul>
|
||||||
</td>
|
</td>
|
||||||
|
@ -186,13 +186,6 @@
|
|||||||
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p152471515133012">Tags in a cluster.</p>
|
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p152471515133012">Tags in a cluster.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0026__row18910102812169"><td class="cellrowborder" valign="top" width="16.333333333333336%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0026__p0911172815167">period</p>
|
|
||||||
</td>
|
|
||||||
<td class="cellrowborder" valign="top" width="24.070707070707073%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0026__p19111528181616">Boolean</p>
|
|
||||||
</td>
|
|
||||||
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0026__p154111215401">Whether the cluster is billed.</p>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
@ -216,7 +209,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="21.5%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0026__p241412301836">String</p>
|
<td class="cellrowborder" valign="top" width="21.5%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0026__p241412301836">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="54.50000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0026__p941413305319">Engine version number. </p>
|
<td class="cellrowborder" valign="top" width="54.50000000000001%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0026__p941413305319">Engine version number.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -346,7 +339,7 @@
|
|||||||
"id": "c2f29369-1985-4028-8e72-89cbb96a299d",
|
"id": "c2f29369-1985-4028-8e72-89cbb96a299d",
|
||||||
"name": "css-5977-ess-esn-1-1",
|
"name": "css-5977-ess-esn-1-1",
|
||||||
"specCode": "css.xlarge.2",
|
"specCode": "css.xlarge.2",
|
||||||
"azCode": "cn-cmcc1a-01"
|
"azCode": "eu-de-01"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"updated": "2020-12-03T07:02:08",
|
"updated": "2020-12-03T07:02:08",
|
||||||
@ -363,9 +356,7 @@
|
|||||||
"diskEncrypted": false,
|
"diskEncrypted": false,
|
||||||
"actionProgress": {},
|
"actionProgress": {},
|
||||||
"actions": [],
|
"actions": [],
|
||||||
"tags": [],
|
"tags": []
|
||||||
"period": false
|
|
||||||
|
|
||||||
}</pre>
|
}</pre>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="css_03_0026__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0026__p41501318171512"><a href="#css_03_0026__table10194172917151">Table 7</a> describes the status code.</p>
|
<div class="section" id="css_03_0026__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0026__p41501318171512"><a href="#css_03_0026__table10194172917151">Table 7</a> describes the status code.</p>
|
||||||
|
@ -64,7 +64,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0031__p1543414094815">String</p>
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0031__p1543414094815">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0031__p194341340174817">Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, <span class="parmname" id="css_03_0031__parmname207181910155010"><b>HH:mm z</b></span>. In the format, <span class="parmname" id="css_03_0031__parmname26580719510"><b>HH:mm</b></span> refers to the hour time and <span class="parmname" id="css_03_0031__parmname12640155145015"><b>z</b></span> refers to the time zone, for example, <span class="parmvalue" id="css_03_0031__parmvalue150123314505"><b>00:00 GMT+08:00</b></span> and <span class="parmvalue" id="css_03_0031__parmvalue1695214431503"><b>01:00 GMT+08:00</b></span>.</p>
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0031__p194341340174817">Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, <span class="parmname" id="css_03_0031__parmname207181910155010"><b>HH:mm z</b></span>. In the format, <span class="parmname" id="css_03_0031__parmname26580719510"><b>HH:mm</b></span> refers to the hour time and <span class="parmname" id="css_03_0031__parmname12640155145015"><b>z</b></span> refers to the time zone, for example, <span class="parmvalue" id="css_03_0031__parmvalue150123314505"><b>00:00 GMT+08:00</b></span> and <span class="parmvalue" id="css_03_0031__parmvalue1695214431503"><b>01:00 GMT+02:00</b></span>.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0031__row1795115595819"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0031__p19952165545814">keepday</p>
|
<tr id="css_03_0031__row1795115595819"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0031__p19952165545814">keepday</p>
|
||||||
@ -104,7 +104,7 @@
|
|||||||
<pre class="screen" id="css_03_0031__screen7841540829">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/policy
|
<pre class="screen" id="css_03_0031__screen7841540829">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/policy
|
||||||
{
|
{
|
||||||
"prefix":"snapshot",
|
"prefix":"snapshot",
|
||||||
"period":"16:00 GMT+08:00",
|
"period":"16:00 GMT+02:00",
|
||||||
"keepday":7,
|
"keepday":7,
|
||||||
"enable":"true"
|
"enable":"true"
|
||||||
}</pre>
|
}</pre>
|
||||||
|
@ -116,7 +116,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<pre class="screen" id="css_03_0032__screen158121459151614">{
|
<pre class="screen" id="css_03_0032__screen158121459151614">{
|
||||||
"keepday":2,
|
"keepday":2,
|
||||||
"period":"16:00 GMT+08:00",
|
"period":"16:00 GMT+02:00",
|
||||||
"prefix":"snapshot",
|
"prefix":"snapshot",
|
||||||
"bucket":"es-backup",
|
"bucket":"es-backup",
|
||||||
"basePath": "css_repository/tests",
|
"basePath": "css_repository/tests",
|
||||||
|
@ -244,7 +244,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0034__p16151201913437">String</p>
|
<td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0034__p16151201913437">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="41.41414141414141%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0034__p8151191912439">Engine version number. </p>
|
<td class="cellrowborder" valign="top" width="41.41414141414141%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0034__p8151191912439">Engine version number.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -257,10 +257,10 @@
|
|||||||
<pre class="screen" id="css_03_0034__screen14418331595">{
|
<pre class="screen" id="css_03_0034__screen14418331595">{
|
||||||
"backups": [
|
"backups": [
|
||||||
{
|
{
|
||||||
"created": "2018-03-07T07:34:47",
|
"created": "2021-03-07T07:34:47",
|
||||||
"datastore": {
|
"datastore": {
|
||||||
"type": "elasticsearch",
|
"type": "elasticsearch",
|
||||||
"version": "*.*.*"
|
"version": "7.6.2"
|
||||||
},
|
},
|
||||||
"description": "",
|
"description": "",
|
||||||
"id": "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9",
|
"id": "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9",
|
||||||
@ -268,7 +268,7 @@
|
|||||||
"clusterName": "Es-xfx",
|
"clusterName": "Es-xfx",
|
||||||
"name": "snapshot-002",
|
"name": "snapshot-002",
|
||||||
"status": "COMPLETED",
|
"status": "COMPLETED",
|
||||||
"updated": "2018-03-07T07:40:12",
|
"updated": "2021-03-07T07:40:12",
|
||||||
"backupType": "1",
|
"backupType": "1",
|
||||||
"backupMethod": "manual",
|
"backupMethod": "manual",
|
||||||
"backupExpectedStartTime": null,
|
"backupExpectedStartTime": null,
|
||||||
@ -277,17 +277,17 @@
|
|||||||
"indices": ".kibana,website2",
|
"indices": ".kibana,website2",
|
||||||
"totalShards": 6,
|
"totalShards": 6,
|
||||||
"failedShards": 0,
|
"failedShards": 0,
|
||||||
"version": "6.2.3",
|
"version": "7.6.2",
|
||||||
"restoreStatus": "success",
|
"restoreStatus": "success",
|
||||||
"startTime": 1520408087099,
|
"startTime": 1520408087099,
|
||||||
"endTime": 1520408412219,
|
"endTime": 1520408412219,
|
||||||
"bucketName": "obs-b8ed"
|
"bucketName": "obs-b8ed"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"created": "2018-03-06T15:42:37",
|
"created": "2021-03-06T15:42:37",
|
||||||
"datastore": {
|
"datastore": {
|
||||||
"type": "elasticsearch",
|
"type": "elasticsearch",
|
||||||
"version": "6.2.3"
|
"version": "7.6.2"
|
||||||
},
|
},
|
||||||
"description": "",
|
"description": "",
|
||||||
"id": "29a2254e-947f-4463-b65a-5f0b17515fae",
|
"id": "29a2254e-947f-4463-b65a-5f0b17515fae",
|
||||||
@ -295,7 +295,7 @@
|
|||||||
"clusterName": "Es-xfx",
|
"clusterName": "Es-xfx",
|
||||||
"name": "snapshot-001",
|
"name": "snapshot-001",
|
||||||
"status": "COMPLETED",
|
"status": "COMPLETED",
|
||||||
"updated": "2018-03-06T15:48:04",
|
"updated": "2021-03-06T15:48:04",
|
||||||
"backupType": "1",
|
"backupType": "1",
|
||||||
"backupMethod": "manual",
|
"backupMethod": "manual",
|
||||||
"backupExpectedStartTime": null,
|
"backupExpectedStartTime": null,
|
||||||
@ -304,7 +304,7 @@
|
|||||||
"indices": ".kibana",
|
"indices": ".kibana",
|
||||||
"totalShards": 1,
|
"totalShards": 1,
|
||||||
"failedShards": 0,
|
"failedShards": 0,
|
||||||
"version": "6.2.3",
|
"version": "7.6.2",
|
||||||
"restoreStatus": "none",
|
"restoreStatus": "none",
|
||||||
"startTime": 1520350957275,
|
"startTime": 1520350957275,
|
||||||
"endTime": 1520351284357,
|
"endTime": 1520351284357,
|
||||||
|
@ -10,10 +10,6 @@
|
|||||||
<ul class="ullinks">
|
<ul class="ullinks">
|
||||||
<li class="ulchildlink"><strong><a href="css_03_0071.html">Obtaining a Project ID and Name</a></strong><br>
|
<li class="ulchildlink"><strong><a href="css_03_0071.html">Obtaining a Project ID and Name</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="css_03_0073.html">Common Request Parameters</a></strong><br>
|
|
||||||
</li>
|
|
||||||
<li class="ulchildlink"><strong><a href="css_03_0074.html">Common Response Parameters</a></strong><br>
|
|
||||||
</li>
|
|
||||||
<li class="ulchildlink"><strong><a href="css_03_0075.html">Status Code</a></strong><br>
|
<li class="ulchildlink"><strong><a href="css_03_0075.html">Status Code</a></strong><br>
|
||||||
</li>
|
</li>
|
||||||
<li class="ulchildlink"><strong><a href="css_03_0076.html">Error Code</a></strong><br>
|
<li class="ulchildlink"><strong><a href="css_03_0076.html">Error Code</a></strong><br>
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
<a name="css_03_0056"></a><a name="css_03_0056"></a>
|
<a name="css_03_0056"></a><a name="css_03_0056"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Supported Cluster Versions</h1>
|
<h1 class="topictitle1">Supported Cluster Versions</h1>
|
||||||
<div id="body8662426"><p id="css_03_0056__p15553102112116">In CSS, Elasticsearch 7.6.2 and 7.9.3 and Kibana 7.6.2 and 7.9.3 are supported.</p>
|
<div id="body8662426"><p id="css_03_0056__p15553102112116">In CSS, Elasticsearch 7.6.2, 7.9.3 and 7.10.2 and Kibana 7.6.2, 7.9.3 and 7.10.2 are supported.</p>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<div class="familylinks">
|
<div class="familylinks">
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
<h1 class="topictitle1">Obtaining a Project ID and Name</h1>
|
<h1 class="topictitle1">Obtaining a Project ID and Name</h1>
|
||||||
<div id="body8662426"><p id="css_03_0071__p194391501803">A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.</p>
|
<div id="body8662426"><p id="css_03_0071__p194391501803">A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.</p>
|
||||||
<div class="section" id="css_03_0071__section05453179582"><h4 class="sectiontitle">Obtaining a Project ID and Name from the Console</h4><ol id="css_03_0071__ol1454591705812"><li id="css_03_0071__li17545201725812">Log in to the console.</li><li id="css_03_0071__li7493103385418">In the upper right corner of the page, click the username and choose <span class="parmname" id="css_03_0071__parmname1463852561418"><b>My Credentials</b></span> from the drop-down list. The <strong id="css_03_0071__b7644132514148">My Credentials</strong> page is displayed.</li><li id="css_03_0071__li15162020201811">In the project list, view the <strong id="css_03_0071__b1936431912218">Project ID</strong> and <strong id="css_03_0071__b944514314213">Project Name</strong>.<div class="fignone" id="css_03_0071__fig267017206014"><span class="figcap"><b>Figure 1 </b>Viewing the project ID and name</span><br><span><img id="css_03_0071__image167013201204" src="en-us_image_0000001261293340.png" title="Click to enlarge" class="imgResize"></span></div>
|
<div class="section" id="css_03_0071__section05453179582"><h4 class="sectiontitle">Obtaining a Project ID and Name from the Console</h4><ol id="css_03_0071__ol1454591705812"><li id="css_03_0071__li17545201725812">Log in to the console.</li><li id="css_03_0071__li7493103385418">In the upper right corner of the page, click the username and choose <span class="parmname" id="css_03_0071__parmname1463852561418"><b>My Credentials</b></span> from the drop-down list. The <strong id="css_03_0071__b7644132514148">My Credentials</strong> page is displayed.</li><li id="css_03_0071__li15162020201811">In the project list, view the <strong id="css_03_0071__b1936431912218">Project ID</strong> and <strong id="css_03_0071__b944514314213">Project Name</strong>.<div class="fignone" id="css_03_0071__fig267017206014"><span class="figcap"><b>Figure 1 </b>Viewing the project ID and name</span><br><span><img id="css_03_0071__image167013201204" src="en-us_image_0000001342150645.png"></span></div>
|
||||||
</li></ol>
|
</li></ol>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="css_03_0071__section16546101713583"><h4 class="sectiontitle">Obtaining a Project ID by Calling an API</h4><p id="css_03_0071__p175461217105811">The API for obtaining a project ID is <strong id="css_03_0071__b6741121815245">GET https://</strong><em id="css_03_0071__i2509162182418">{iam-endpoint}</em><strong id="css_03_0071__b9837723102418">/v3/projects</strong>. <em id="css_03_0071__i1437102719246">{iam-endpoint}</em> indicates the endpoint of IAM, which can be obtained from <a href="css_03_0053.html">Endpoints</a>.</p>
|
<div class="section" id="css_03_0071__section16546101713583"><h4 class="sectiontitle">Obtaining a Project ID by Calling an API</h4><p id="css_03_0071__p175461217105811">The API for obtaining a project ID is <strong id="css_03_0071__b6741121815245">GET https://</strong><em id="css_03_0071__i2509162182418">{iam-endpoint}</em><strong id="css_03_0071__b9837723102418">/v3/projects</strong>. <em id="css_03_0071__i1437102719246">{iam-endpoint}</em> indicates the endpoint of IAM, which can be obtained from <a href="css_03_0053.html">Endpoints</a>.</p>
|
||||||
@ -38,10 +38,3 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
<script language="JavaScript">
|
|
||||||
<!--
|
|
||||||
image_size('.imgResize');
|
|
||||||
var msg_imageMax = "view original image";
|
|
||||||
var msg_imageClose = "close";
|
|
||||||
//--></script>
|
|
@ -104,35 +104,35 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section" id="css_03_0078__section262385181716"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0078__p46921709171"><a href="#css_03_0078__table12321369178">Table 4</a> describes the status code.</p>
|
<div class="section" id="css_03_0078__section262385181716"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0078__p46921709171"><a href="#css_03_0078__table12321369178">Table 4</a> describes the status code.</p>
|
||||||
|
|
||||||
<div class="tablenoborder"><a name="css_03_0078__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0078__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="css_03_0078__css_03_0018_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="25.240000000000002%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0078__css_03_0018_p14560134151414">Status Code</p>
|
<div class="tablenoborder"><a name="css_03_0078__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0078__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="css_03_0078__en-us_topic_0075288550_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="25.240000000000002%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0078__en-us_topic_0075288550_p14560134151414">Status Code</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="33.21%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0078__css_03_0018_p5563194141411">Message</p>
|
<th align="left" class="cellrowborder" valign="top" width="33.21%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0078__en-us_topic_0075288550_p5563194141411">Message</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="41.55%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0078__css_03_0018_p256616411143">Description</p>
|
<th align="left" class="cellrowborder" valign="top" width="41.55%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0078__en-us_topic_0075288550_p256616411143">Description</p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody><tr id="css_03_0078__css_03_0018_row129720356144"><td class="cellrowborder" valign="top" width="25.240000000000002%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0078__css_03_0018_p1957004131410">400</p>
|
<tbody><tr id="css_03_0078__en-us_topic_0075288550_row129720356144"><td class="cellrowborder" valign="top" width="25.240000000000002%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0078__en-us_topic_0075288550_p1957004131410">400</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="33.21%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0078__css_03_0018_p165731141171419">BadRequest</p>
|
<td class="cellrowborder" valign="top" width="33.21%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0078__en-us_topic_0075288550_p165731141171419">BadRequest</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0078__css_03_0018_p65778413148">Invalid request.</p>
|
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0078__en-us_topic_0075288550_p65778413148">Invalid request.</p>
|
||||||
<p id="css_03_0078__css_03_0018_p1557974171415">The client should not repeat the request without modifications.</p>
|
<p id="css_03_0078__en-us_topic_0075288550_p1557974171415">The client should not repeat the request without modifications.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0078__css_03_0018_row8972103517147"><td class="cellrowborder" valign="top" width="25.240000000000002%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0078__css_03_0018_p75841441191410">404</p>
|
<tr id="css_03_0078__en-us_topic_0075288550_row8972103517147"><td class="cellrowborder" valign="top" width="25.240000000000002%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0078__en-us_topic_0075288550_p75841441191410">404</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="33.21%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0078__css_03_0018_p258716416142">NotFound</p>
|
<td class="cellrowborder" valign="top" width="33.21%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0078__en-us_topic_0075288550_p258716416142">NotFound</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0078__css_03_0018_p15589154118141">The requested resource cannot be found.</p>
|
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0078__en-us_topic_0075288550_p15589154118141">The requested resource cannot be found.</p>
|
||||||
<p id="css_03_0078__css_03_0018_p14590164151410">The client should not repeat the request without modifications.</p>
|
<p id="css_03_0078__en-us_topic_0075288550_p14590164151410">The client should not repeat the request without modifications.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0078__css_03_0018_row297223511416"><td class="cellrowborder" valign="top" width="25.240000000000002%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0078__css_03_0018_p13595164131416">200</p>
|
<tr id="css_03_0078__en-us_topic_0075288550_row297223511416"><td class="cellrowborder" valign="top" width="25.240000000000002%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0078__en-us_topic_0075288550_p13595164131416">200</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="33.21%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0078__css_03_0018_p9598741131416">OK</p>
|
<td class="cellrowborder" valign="top" width="33.21%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0078__en-us_topic_0075288550_p9598741131416">OK</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0078__css_03_0018_p659994115146">The request is processed successfully.</p>
|
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0078__en-us_topic_0075288550_p659994115146">The request is processed successfully.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -101,35 +101,35 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section" id="css_03_0079__section262385181716"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0079__p46921709171"><a href="#css_03_0079__table12321369178">Table 4</a> describes the status code.</p>
|
<div class="section" id="css_03_0079__section262385181716"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0079__p46921709171"><a href="#css_03_0079__table12321369178">Table 4</a> describes the status code.</p>
|
||||||
|
|
||||||
<div class="tablenoborder"><a name="css_03_0079__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0079__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="css_03_0079__css_03_0018_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0079__css_03_0018_p14560134151414">Status Code</p>
|
<div class="tablenoborder"><a name="css_03_0079__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0079__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="css_03_0079__en-us_topic_0075288550_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0079__en-us_topic_0075288550_p14560134151414">Status Code</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="24.51%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0079__css_03_0018_p5563194141411">Message</p>
|
<th align="left" class="cellrowborder" valign="top" width="24.51%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0079__en-us_topic_0075288550_p5563194141411">Message</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0079__css_03_0018_p256616411143">Description</p>
|
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0079__en-us_topic_0075288550_p256616411143">Description</p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody><tr id="css_03_0079__css_03_0018_row129720356144"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0079__css_03_0018_p1957004131410">400</p>
|
<tbody><tr id="css_03_0079__en-us_topic_0075288550_row129720356144"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0079__en-us_topic_0075288550_p1957004131410">400</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0079__css_03_0018_p165731141171419">BadRequest</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0079__en-us_topic_0075288550_p165731141171419">BadRequest</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0079__css_03_0018_p65778413148">Invalid request.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0079__en-us_topic_0075288550_p65778413148">Invalid request.</p>
|
||||||
<p id="css_03_0079__css_03_0018_p1557974171415">The client should not repeat the request without modifications.</p>
|
<p id="css_03_0079__en-us_topic_0075288550_p1557974171415">The client should not repeat the request without modifications.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0079__css_03_0018_row8972103517147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0079__css_03_0018_p75841441191410">404</p>
|
<tr id="css_03_0079__en-us_topic_0075288550_row8972103517147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0079__en-us_topic_0075288550_p75841441191410">404</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0079__css_03_0018_p258716416142">NotFound</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0079__en-us_topic_0075288550_p258716416142">NotFound</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0079__css_03_0018_p15589154118141">The requested resource cannot be found.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0079__en-us_topic_0075288550_p15589154118141">The requested resource cannot be found.</p>
|
||||||
<p id="css_03_0079__css_03_0018_p14590164151410">The client should not repeat the request without modifications.</p>
|
<p id="css_03_0079__en-us_topic_0075288550_p14590164151410">The client should not repeat the request without modifications.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0079__css_03_0018_row297223511416"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0079__css_03_0018_p13595164131416">200</p>
|
<tr id="css_03_0079__en-us_topic_0075288550_row297223511416"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0079__en-us_topic_0075288550_p13595164131416">200</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0079__css_03_0018_p9598741131416">OK</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0079__en-us_topic_0075288550_p9598741131416">OK</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0079__css_03_0018_p659994115146">The request is processed successfully.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0079__en-us_topic_0075288550_p659994115146">The request is processed successfully.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -136,35 +136,35 @@
|
|||||||
</li></ul>
|
</li></ul>
|
||||||
<div class="section" id="css_03_0081__section453243119012"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0081__p46921709171"><a href="#css_03_0081__table12321369178">Table 4</a> describes status codes.</p>
|
<div class="section" id="css_03_0081__section453243119012"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0081__p46921709171"><a href="#css_03_0081__table12321369178">Table 4</a> describes status codes.</p>
|
||||||
|
|
||||||
<div class="tablenoborder"><a name="css_03_0081__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0081__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="css_03_0081__css_03_0018_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.9.3.2.4.1.1"><p id="css_03_0081__css_03_0018_p14560134151414">Status Code</p>
|
<div class="tablenoborder"><a name="css_03_0081__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0081__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="css_03_0081__en-us_topic_0075288550_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.9.3.2.4.1.1"><p id="css_03_0081__en-us_topic_0075288550_p14560134151414">Status Code</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="24.51%" id="mcps1.3.9.3.2.4.1.2"><p id="css_03_0081__css_03_0018_p5563194141411">Encoding</p>
|
<th align="left" class="cellrowborder" valign="top" width="24.51%" id="mcps1.3.9.3.2.4.1.2"><p id="css_03_0081__en-us_topic_0075288550_p5563194141411">Encoding</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.9.3.2.4.1.3"><p id="css_03_0081__css_03_0018_p256616411143">Description</p>
|
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.9.3.2.4.1.3"><p id="css_03_0081__en-us_topic_0075288550_p256616411143">Description</p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody><tr id="css_03_0081__css_03_0018_row129720356144"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.9.3.2.4.1.1 "><p id="css_03_0081__css_03_0018_p1957004131410">400</p>
|
<tbody><tr id="css_03_0081__en-us_topic_0075288550_row129720356144"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.9.3.2.4.1.1 "><p id="css_03_0081__en-us_topic_0075288550_p1957004131410">400</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.9.3.2.4.1.2 "><p id="css_03_0081__css_03_0018_p165731141171419">BadRequest</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.9.3.2.4.1.2 "><p id="css_03_0081__en-us_topic_0075288550_p165731141171419">BadRequest</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.9.3.2.4.1.3 "><p id="css_03_0081__css_03_0018_p65778413148">Invalid request.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.9.3.2.4.1.3 "><p id="css_03_0081__en-us_topic_0075288550_p65778413148">Invalid request.</p>
|
||||||
<p id="css_03_0081__css_03_0018_p1557974171415">Do not retry the request before modification.</p>
|
<p id="css_03_0081__en-us_topic_0075288550_p1557974171415">Do not retry the request before modification.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0081__css_03_0018_row8972103517147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.9.3.2.4.1.1 "><p id="css_03_0081__css_03_0018_p75841441191410">404</p>
|
<tr id="css_03_0081__en-us_topic_0075288550_row8972103517147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.9.3.2.4.1.1 "><p id="css_03_0081__en-us_topic_0075288550_p75841441191410">404</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.9.3.2.4.1.2 "><p id="css_03_0081__css_03_0018_p258716416142">NotFound</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.9.3.2.4.1.2 "><p id="css_03_0081__en-us_topic_0075288550_p258716416142">NotFound</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.9.3.2.4.1.3 "><p id="css_03_0081__css_03_0018_p15589154118141">The requested resource cannot be found.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.9.3.2.4.1.3 "><p id="css_03_0081__en-us_topic_0075288550_p15589154118141">The requested resource cannot be found.</p>
|
||||||
<p id="css_03_0081__css_03_0018_p14590164151410">Do not retry the request before modification.</p>
|
<p id="css_03_0081__en-us_topic_0075288550_p14590164151410">Do not retry the request before modification.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0081__css_03_0018_row297223511416"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.9.3.2.4.1.1 "><p id="css_03_0081__css_03_0018_p13595164131416">204</p>
|
<tr id="css_03_0081__en-us_topic_0075288550_row297223511416"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.9.3.2.4.1.1 "><p id="css_03_0081__en-us_topic_0075288550_p13595164131416">204</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.9.3.2.4.1.2 "><p id="css_03_0081__css_03_0018_p9598741131416">OK</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.9.3.2.4.1.2 "><p id="css_03_0081__en-us_topic_0075288550_p9598741131416">OK</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.9.3.2.4.1.3 "><p id="css_03_0081__css_03_0018_p659994115146">The request is processed successfully.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.9.3.2.4.1.3 "><p id="css_03_0081__en-us_topic_0075288550_p659994115146">The request is processed successfully.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
<a name="css_03_0082"></a><a name="css_03_0082"></a>
|
<a name="css_03_0082"></a><a name="css_03_0082"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Deleting Specified Cluster Tags </h1>
|
<h1 class="topictitle1">Deleting Specified Cluster Tags</h1>
|
||||||
<div id="body1602483981348"><div class="section" id="css_03_0082__section4887181417219"><h4 class="sectiontitle">Function</h4><p id="css_03_0082__p2960293467">This API is used to delete specified cluster tags.</p>
|
<div id="body1602483981348"><div class="section" id="css_03_0082__section4887181417219"><h4 class="sectiontitle">Function</h4><p id="css_03_0082__p2960293467">This API is used to delete specified cluster tags.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="css_03_0082__section186642510215"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0082__screen13361126174613">DELETE /v1.0/{project_id}/css-cluster/{cluster_id}/tags/{key}</pre>
|
<div class="section" id="css_03_0082__section186642510215"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0082__screen13361126174613">DELETE /v1.0/{project_id}/css-cluster/{cluster_id}/tags/{key}</pre>
|
||||||
@ -22,7 +22,6 @@
|
|||||||
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0082__p989172972410">String</p>
|
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0082__p989172972410">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="37.95%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0082__p14897293244">Project ID</p>
|
<td class="cellrowborder" valign="top" width="37.95%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0082__p14897293244">Project ID</p>
|
||||||
<p id="css_03_0082__p1869916551714"></p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0082__row88914291247"><td class="cellrowborder" valign="top" width="14.48%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0082__p178912982419">cluster_id</p>
|
<tr id="css_03_0082__row88914291247"><td class="cellrowborder" valign="top" width="14.48%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0082__p178912982419">cluster_id</p>
|
||||||
@ -58,35 +57,35 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section" id="css_03_0082__section25681378225"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0082__css_03_0081_p46921709171"><a href="#css_03_0082__css_03_0081_table12321369178">Table 2</a> describes status codes.</p>
|
<div class="section" id="css_03_0082__section25681378225"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0082__css_03_0081_p46921709171"><a href="#css_03_0082__css_03_0081_table12321369178">Table 2</a> describes status codes.</p>
|
||||||
|
|
||||||
<div class="tablenoborder"><a name="css_03_0082__css_03_0081_table12321369178"></a><a name="css_03_0081_table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0082__css_03_0081_table12321369178" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="css_03_0082__css_03_0081_css_03_0018_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0082__css_03_0081_css_03_0018_p14560134151414">Status Code</p>
|
<div class="tablenoborder"><a name="css_03_0082__css_03_0081_table12321369178"></a><a name="css_03_0081_table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0082__css_03_0081_table12321369178" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="css_03_0082__css_03_0081_en-us_topic_0075288550_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p14560134151414">Status Code</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="24.51%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0082__css_03_0081_css_03_0018_p5563194141411">Encoding</p>
|
<th align="left" class="cellrowborder" valign="top" width="24.51%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p5563194141411">Encoding</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0082__css_03_0081_css_03_0018_p256616411143">Description</p>
|
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p256616411143">Description</p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody><tr id="css_03_0082__css_03_0081_css_03_0018_row129720356144"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0082__css_03_0081_css_03_0018_p1957004131410">400</p>
|
<tbody><tr id="css_03_0082__css_03_0081_en-us_topic_0075288550_row129720356144"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p1957004131410">400</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0082__css_03_0081_css_03_0018_p165731141171419">BadRequest</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p165731141171419">BadRequest</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0082__css_03_0081_css_03_0018_p65778413148">Invalid request.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p65778413148">Invalid request.</p>
|
||||||
<p id="css_03_0082__css_03_0081_css_03_0018_p1557974171415">Do not retry the request before modification.</p>
|
<p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p1557974171415">Do not retry the request before modification.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0082__css_03_0081_css_03_0018_row8972103517147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0082__css_03_0081_css_03_0018_p75841441191410">404</p>
|
<tr id="css_03_0082__css_03_0081_en-us_topic_0075288550_row8972103517147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p75841441191410">404</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0082__css_03_0081_css_03_0018_p258716416142">NotFound</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p258716416142">NotFound</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0082__css_03_0081_css_03_0018_p15589154118141">The requested resource cannot be found.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p15589154118141">The requested resource cannot be found.</p>
|
||||||
<p id="css_03_0082__css_03_0081_css_03_0018_p14590164151410">Do not retry the request before modification.</p>
|
<p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p14590164151410">Do not retry the request before modification.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0082__css_03_0081_css_03_0018_row297223511416"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0082__css_03_0081_css_03_0018_p13595164131416">204</p>
|
<tr id="css_03_0082__css_03_0081_en-us_topic_0075288550_row297223511416"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p13595164131416">204</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0082__css_03_0081_css_03_0018_p9598741131416">OK</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p9598741131416">OK</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0082__css_03_0081_css_03_0018_p659994115146">The request is processed successfully.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0082__css_03_0081_en-us_topic_0075288550_p659994115146">The request is processed successfully.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
@ -22,7 +22,6 @@
|
|||||||
<td class="cellrowborder" valign="top" width="22.259999999999998%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0083__p115141546165810">String</p>
|
<td class="cellrowborder" valign="top" width="22.259999999999998%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0083__p115141546165810">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="31.66%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0083__p251414460586">Project ID</p>
|
<td class="cellrowborder" valign="top" width="31.66%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0083__p251414460586">Project ID</p>
|
||||||
<p id="css_03_0083__p1869916551714"></p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0083__row17514184616581"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0083__p751434620586">cluster_id</p>
|
<tr id="css_03_0083__row17514184616581"><td class="cellrowborder" valign="top" width="21.349999999999998%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0083__p751434620586">cluster_id</p>
|
||||||
@ -87,35 +86,35 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section" id="css_03_0083__section2518650143716"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0083__css_03_0081_p46921709171"><a href="#css_03_0083__css_03_0081_table12321369178">Table 3</a> describes status codes.</p>
|
<div class="section" id="css_03_0083__section2518650143716"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0083__css_03_0081_p46921709171"><a href="#css_03_0083__css_03_0081_table12321369178">Table 3</a> describes status codes.</p>
|
||||||
|
|
||||||
<div class="tablenoborder"><a name="css_03_0083__css_03_0081_table12321369178"></a><a name="css_03_0081_table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0083__css_03_0081_table12321369178" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="css_03_0083__css_03_0081_css_03_0018_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0083__css_03_0081_css_03_0018_p14560134151414">Status Code</p>
|
<div class="tablenoborder"><a name="css_03_0083__css_03_0081_table12321369178"></a><a name="css_03_0081_table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0083__css_03_0081_table12321369178" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="css_03_0083__css_03_0081_en-us_topic_0075288550_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p14560134151414">Status Code</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="24.51%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0083__css_03_0081_css_03_0018_p5563194141411">Encoding</p>
|
<th align="left" class="cellrowborder" valign="top" width="24.51%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p5563194141411">Encoding</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0083__css_03_0081_css_03_0018_p256616411143">Description</p>
|
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p256616411143">Description</p>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody><tr id="css_03_0083__css_03_0081_css_03_0018_row129720356144"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0083__css_03_0081_css_03_0018_p1957004131410">400</p>
|
<tbody><tr id="css_03_0083__css_03_0081_en-us_topic_0075288550_row129720356144"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p1957004131410">400</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0083__css_03_0081_css_03_0018_p165731141171419">BadRequest</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p165731141171419">BadRequest</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0083__css_03_0081_css_03_0018_p65778413148">Invalid request.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p65778413148">Invalid request.</p>
|
||||||
<p id="css_03_0083__css_03_0081_css_03_0018_p1557974171415">Do not retry the request before modification.</p>
|
<p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p1557974171415">Do not retry the request before modification.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0083__css_03_0081_css_03_0018_row8972103517147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0083__css_03_0081_css_03_0018_p75841441191410">404</p>
|
<tr id="css_03_0083__css_03_0081_en-us_topic_0075288550_row8972103517147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p75841441191410">404</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0083__css_03_0081_css_03_0018_p258716416142">NotFound</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p258716416142">NotFound</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0083__css_03_0081_css_03_0018_p15589154118141">The requested resource cannot be found.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p15589154118141">The requested resource cannot be found.</p>
|
||||||
<p id="css_03_0083__css_03_0081_css_03_0018_p14590164151410">Do not retry the request before modification.</p>
|
<p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p14590164151410">Do not retry the request before modification.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="css_03_0083__css_03_0081_css_03_0018_row297223511416"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0083__css_03_0081_css_03_0018_p13595164131416">204</p>
|
<tr id="css_03_0083__css_03_0081_en-us_topic_0075288550_row297223511416"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p13595164131416">204</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0083__css_03_0081_css_03_0018_p9598741131416">OK</p>
|
<td class="cellrowborder" valign="top" width="24.51%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p9598741131416">OK</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0083__css_03_0081_css_03_0018_p659994115146">The request is processed successfully.</p>
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0083__css_03_0081_en-us_topic_0075288550_p659994115146">The request is processed successfully.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
BIN
docs/css/api-ref/en-us_image_0000001289590960.png
Normal file
BIN
docs/css/api-ref/en-us_image_0000001289590960.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 50 KiB |
BIN
docs/css/api-ref/en-us_image_0000001342150645.png
Normal file
BIN
docs/css/api-ref/en-us_image_0000001342150645.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.3 KiB |
@ -43,16 +43,46 @@
|
|||||||
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section580035055419"><h4 class="sectiontitle">Request Methods</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p65661618145510">HTTP-based request methods, which are also called operations or actions, specify the type of operations that you are requesting.</p>
|
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section580035055419"><h4 class="sectiontitle">Request Methods</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p65661618145510">HTTP-based request methods, which are also called operations or actions, specify the type of operations that you are requesting.</p>
|
||||||
<ul id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_ul11356238151312"><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li1835819385137"><strong id="iam_02_0008__en-us_topic_0170917207_b12857113714364">GET</strong>: requests the server to return specified resources.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li95631239131310"><strong id="iam_02_0008__en-us_topic_0170917207_b59328463362">PUT</strong>: requests the server to update specified resources.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li1554910413138"><strong id="iam_02_0008__en-us_topic_0170917207_b2281114933619">POST</strong>: requests the server to add resources or perform special operations.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li8237114421314"><strong id="iam_02_0008__en-us_topic_0170917207_b54061951103612">DELETE</strong>: requests the server to delete specified resources, for example, an object.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li165331349151317"><strong id="iam_02_0008__en-us_topic_0170917207_b399416532361">HEAD</strong>: requests a server resource header.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li4440175411313"><strong id="iam_02_0008__en-us_topic_0170917207_b09452020375">PATCH</strong>: requests the server to update partial content of a specified resource. If the target resource does not exist, PATCH may create a resource.</li></ul>
|
<ul id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_ul11356238151312"><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li1835819385137"><strong id="iam_02_0008__en-us_topic_0170917207_b12857113714364">GET</strong>: requests the server to return specified resources.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li95631239131310"><strong id="iam_02_0008__en-us_topic_0170917207_b59328463362">PUT</strong>: requests the server to update specified resources.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li1554910413138"><strong id="iam_02_0008__en-us_topic_0170917207_b2281114933619">POST</strong>: requests the server to add resources or perform special operations.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li8237114421314"><strong id="iam_02_0008__en-us_topic_0170917207_b54061951103612">DELETE</strong>: requests the server to delete specified resources, for example, an object.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li165331349151317"><strong id="iam_02_0008__en-us_topic_0170917207_b399416532361">HEAD</strong>: requests a server resource header.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li4440175411313"><strong id="iam_02_0008__en-us_topic_0170917207_b09452020375">PATCH</strong>: requests the server to update partial content of a specified resource. If the target resource does not exist, PATCH may create a resource.</li></ul>
|
||||||
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p3759142614815">If <strong id="iam_02_0008__b2080910410304">POST</strong> is displayed in the URI of the API for obtaining a user token, the request is as follows:</p>
|
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p3759142614815">If <strong id="iam_02_0008__b2080910410304">POST</strong> is displayed in the URI of the API for obtaining a user token, the request is as follows:</p>
|
||||||
<pre class="screen" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_screen1278712381542">
|
<pre class="screen" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_screen1278712381542">POST https://<em id="iam_02_0008__i8606173611145">{iam-endpoint}</em>/v3/auth/tokens</pre>
|
||||||
POST https://<em id="iam_02_0008__i8606173611145">{iam-endpoint}</em>/v3/auth/tokens</pre>
|
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section1454211155819"><h4 class="sectiontitle">Request Header</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p11811752397">You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, add <span class="parmname" id="iam_02_0008__en-us_topic_0170917207_parmname555313733714"><b>Content-Type</b></span> that defines a request body type to request for the authentication information.</p>
|
<div class="section" id="iam_02_0008__section1256734431915"><h4 class="sectiontitle">Request Header</h4><p id="iam_02_0008__p5567344131912">You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, add <span class="parmname" id="iam_02_0008__parmname18567144111916"><b>Content-Type</b></span> that defines a request body type to request for the authentication information.</p>
|
||||||
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p1467193205816">Common request headers are as follows:</p>
|
<p id="iam_02_0008__p165677441197"><a href="#iam_02_0008__table181671338175614">Table 2</a> lists common request header fields.</p>
|
||||||
<ul id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_ul157293410593"><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li972916419595"><strong id="iam_02_0008__en-us_topic_0170917207_b45271744123718">Content-Type</strong>: specifies the request body type or format. This field is mandatory and its default value is <span class="parmvalue" id="iam_02_0008__en-us_topic_0170917207_parmvalue195281444123719"><b>application/json</b></span>.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li1642421012595"><strong id="iam_02_0008__en-us_topic_0170917207_b576882411312">X-Auth-Token</strong>: specifies the user token, which is optional. This field is mandatory for token-based authentication. <strong id="iam_02_0008__b1573516520309">X-Auth-Token</strong> is the value of <strong id="iam_02_0008__b4543355203011">x-subject-token</strong> returned in response to the API used to obtain a user token.<div class="note" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_note13771123325011"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p1513412221808">In addition to supporting authentication using tokens, APIs support authentication using the access key ID (AK)/secret access key (SK), which uses SDKs to sign a request. During the signing, the <strong id="iam_02_0008__en-us_topic_0170917207_b4241256143814">Authorization</strong> (signature authentication information) and <strong id="iam_02_0008__en-us_topic_0170917207_b624213569385">X-Sdk-Date</strong> (time when a request is sent) headers are automatically added to the request. For more details, see <a href="iam_02_0510.html">Authentication Using AK/SK</a>.</p>
|
|
||||||
</div></div>
|
<div class="tablenoborder"><a name="iam_02_0008__table181671338175614"></a><a name="table181671338175614"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0008__table181671338175614" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Common request headers</caption><thead align="left"><tr id="iam_02_0008__row101671738165610"><th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.4.4.2.4.1.1"><p id="iam_02_0008__p71671738165620">Parameter</p>
|
||||||
</li></ul>
|
</th>
|
||||||
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p42118461957">The API used to obtain a user token does not require authentication. Therefore, only the <span class="parmname" id="iam_02_0008__parmname17151815123115"><b>Content-Type</b></span> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
|
<th align="left" class="cellrowborder" valign="top" width="25.94%" id="mcps1.3.4.4.2.4.1.2"><p id="iam_02_0008__p14168193875620">Mandatory</p>
|
||||||
<pre class="screen" id="iam_02_0008__en-us_topic_0170917207_screen10131730155612">POST https://<em id="iam_02_0008__i16184129191410">{iam-endpoint}</em>/v3/auth/tokens
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="45.06%" id="mcps1.3.4.4.2.4.1.3"><p id="iam_02_0008__p18168113813566">Description</p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="iam_02_0008__row1496219145718"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_02_0008__p146101031910">Content-Type</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_02_0008__p14610103018">Yes</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_02_0008__p1161017320119">Message body type (or format). You are advised to use the default value <strong id="iam_02_0008__b78381027132017">application/json</strong>.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="iam_02_0008__row269463916566"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_02_0008__p783917594568">X-Auth-Token</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_02_0008__p48391959195610">No (Mandatory for token-based authentication)</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_02_0008__p108391599569">User token.</p>
|
||||||
|
<p id="iam_02_0008__p192053105915">User token is the response to the API for obtaining a user token (only this API does not require authentication). After the request is processed, the value of <strong id="iam_02_0008__b123781111102211">X-Subject-Token</strong> in the response header (Header) is the token value.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="iam_02_0008__row3653847137"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_02_0008__p17697145912311">X-Language</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_02_0008__p369785915313">No</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_02_0008__p269715591239">Request language</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<p id="iam_02_0008__p3568184413190">The API used to obtain a user token does not require authentication. Therefore, only the <span class="parmname" id="iam_02_0008__parmname135681544151916"><b>Content-Type</b></span> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
|
||||||
|
<pre class="screen" id="iam_02_0008__screen1456815449192">POST https://<em id="iam_02_0008__i45681444171916">{iam-endpoint}</em>/v3/auth/tokens
|
||||||
Content-Type: application/json</pre>
|
Content-Type: application/json</pre>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section14612192315587"><h4 class="sectiontitle">Request Body</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p23132011213">A request body conveys information other than the request header and is generally sent in a structured format defined by the request header field <strong id="iam_02_0008__en-us_topic_0170917207_b1328019465393">Content-Type</strong>. </p>
|
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section14612192315587"><h4 class="sectiontitle">Request Body</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p23132011213">A request body conveys information other than the request header and is generally sent in a structured format defined by the request header field <strong id="iam_02_0008__en-us_topic_0170917207_b1328019465393">Content-Type</strong>. </p>
|
||||||
|
@ -7,7 +7,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_section7804143005810"><h4 class="sectiontitle">Response Header</h4><p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p384320471837">A response header corresponds to a request header, for example, <span class="parmvalue" id="iam_02_0511__en-us_topic_0170917209_parmvalue946210448619"><b>Content-Type</b></span>.</p>
|
<div class="section" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_section7804143005810"><h4 class="sectiontitle">Response Header</h4><p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p384320471837">A response header corresponds to a request header, for example, <span class="parmvalue" id="iam_02_0511__en-us_topic_0170917209_parmvalue946210448619"><b>Content-Type</b></span>.</p>
|
||||||
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p4430113619484"><a href="#iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511">Figure 1</a> shows the response header for the API of obtaining a user token, where <span class="parmname" id="iam_02_0511__en-us_topic_0170917209_parmname109780549620"><b>x-subject-token</b></span> is the desired user token. Then, you can use the token to authenticate the calling of other APIs.</p>
|
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p4430113619484"><a href="#iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511">Figure 1</a> shows the response header for the API of obtaining a user token, where <span class="parmname" id="iam_02_0511__en-us_topic_0170917209_parmname109780549620"><b>x-subject-token</b></span> is the desired user token. Then, you can use the token to authenticate the calling of other APIs.</p>
|
||||||
<div class="fignone" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"><a name="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"></a><a name="en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header of the response to the request for obtaining a user token</span><br><span><img id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_image48651610135113" src="en-us_image_0000001265939134.png" title="Click to enlarge" class="imgResize"></span></div>
|
<div class="fignone" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"><a name="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"></a><a name="en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header of the response to the request for obtaining a user token</span><br><span><img id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_image48651610135113" src="en-us_image_0000001289590960.png"></span></div>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_section034615592583"><h4 class="sectiontitle">Response Body</h4><p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p133921631940">A response body is generally returned in a structured format, corresponding to the <strong id="iam_02_0511__en-us_topic_0170917209_b59654378715">Content-Type</strong> in the response header, and is used to transfer content other than the response header.</p>
|
<div class="section" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_section034615592583"><h4 class="sectiontitle">Response Body</h4><p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p133921631940">A response body is generally returned in a structured format, corresponding to the <strong id="iam_02_0511__en-us_topic_0170917209_b59654378715">Content-Type</strong> in the response header, and is used to transfer content other than the response header.</p>
|
||||||
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p157041652367">The following shows part of the response body for the API of obtaining a user token.</p>
|
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p157041652367">The following shows part of the response body for the API of obtaining a user token.</p>
|
||||||
@ -37,10 +37,3 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
<script language="JavaScript">
|
|
||||||
<!--
|
|
||||||
image_size('.imgResize');
|
|
||||||
var msg_imageMax = "view original image";
|
|
||||||
var msg_imageClose = "close";
|
|
||||||
//--></script>
|
|
Binary file not shown.
Before Width: | Height: | Size: 68 B After Width: | Height: | Size: 1.8 KiB |
Binary file not shown.
Before Width: | Height: | Size: 70 B After Width: | Height: | Size: 1.8 KiB |
Loading…
x
Reference in New Issue
Block a user