Files
doc-exports/docs/css/api-ref/css_03_0101.html
zhengxiu d48ac439de css api 25.1.0 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: zhengxiu <zhengxiu@huawei.com>
Co-committed-by: zhengxiu <zhengxiu@huawei.com>
2025-05-28 09:20:51 +00:00

78 lines
4.0 KiB
HTML

<a name="css_03_0101"></a><a name="css_03_0101"></a>
<h1 class="topictitle1">Obtaining the Cluster ID</h1>
<div id="body0000002105021852"><p id="css_03_0101__p6678872317">A cluster ID (<strong id="css_03_0101__b2139590178111625">cluster_id</strong>) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:</p>
<div class="section" id="css_03_0101__section9167142742316"><h4 class="sectiontitle">Obtaining the Cluster ID by Calling an API</h4><p id="css_03_0101__p105241039102315">You can obtain the cluster ID by calling the Querying the Cluster List API.</p>
</div>
<p id="css_03_0101__p3676817239">The API for obtaining the cluster ID is GET https://{Endpoint}/v1.0/{project_id}/clusters, where {Endpoint} indicates the IAM endpoint, which can be obtained from Regions and Endpoints. For the project ID, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>. For API authentication, see <a href="css_03_0079.html">Authentication</a>.</p>
<p id="css_03_0101__p46758102319">The following is an example response. The value of <strong id="css_03_0101__b628115202111625">id</strong> under <strong id="css_03_0101__b3252182662816">clusters</strong> is the cluster ID.</p>
<p id="css_03_0101__p149801136162416"></p>
<pre class="screen" id="css_03_0101__screen347514292416">{
"totalSize" : 1,
"clusters" : [ {
"datastore" : {
"type" : "elasticsearch",
"version" : "7.10.2",
"subVersion" : "7.10.2_24.3.0_0827",
"isEosCluster" : false,
"supportSecuritymode" : false
},
"instances" : [ {
"status" : "200",
"type" : "ess",
"id" : "{INSTANCE_ID}",
"name" : "css-8bc5-ess-esn-1-1",
"specCode" : "ess.spec-4u8g",
"azCode" : "{AZ_CODE}",
"volume" : {
"type" : "ULTRAHIGH",
"size" : 40,
"resourceIds" : [ "{RESOURCE_ID}" ]
},
"ip" : "192.168.0.122",
"resourceId" : "{RESOURCE_ID}"
} ],
"publicKibanaResp" : {
"eipSize" : 10,
"publicKibanaIp" : "100.95.152.28:9200",
"elbWhiteListResp" : null,
"bandwidthResourceId" : "18bec13f-5cc1-4631-867f-33505d15be12"
},
"elbWhiteList" : {
"whiteList" : "",
"enableWhiteList" : false
},
"updated" : "2023-10-09T02:07:13",
"name" : "css-8bc5",
"publicIp" : "100.85.222.202",
"created" : "2023-10-09T02:07:13",
"id" : "{CLUSTER_ID}",
"status" : "200",
"endpoint" : "192.168.0.122:9200",
"vpcId" : "{VPC_ID}",
"subnetId" : "{SUBNET_ID}",
"securityGroupId" : "{SECURITY_GROUP_ID}",
"bandwidthResourceId" : "{BANDWIDTH_RESOURCE_ID}",
"bandwidthSize" : 3,
"httpsEnable" : true,
"authorityEnable" : true,
"diskEncrypted" : false,
"backupAvailable" : false,
"actionProgress" : { },
"actions" : [ ],
"enterpriseProjectId" : "0",
"tags" : [ ],
"period" : true
} ]
}</pre>
<div class="section" id="css_03_0101__section169621213112416"><h4 class="sectiontitle">Obtaining the Cluster ID from the GaussDB(DWS) Console</h4><ol id="css_03_0101__ol14373014619"><li id="css_03_0101__li124370017461">Log in to the CSS management console.</li><li id="css_03_0101__li1818012104466">In the navigation pane on the left, click <span class="parmname" id="css_03_0101__parmname1521820506111625"><b>Clusters</b></span>.</li><li id="css_03_0101__li172081715104617">In the cluster list, find the target cluster and click the cluster name. The <span class="wintitle" id="css_03_0101__wintitle2059145261111625"><b>Cluster Information</b></span> page is displayed.</li><li id="css_03_0101__li834913208462">Check the cluster ID under cluster information.<div class="fignone" id="css_03_0101__fig207631632143512"><span class="figcap"><b>Figure 1 </b>Checking the cluster ID</span><br><span><img id="css_03_0101__image163542220352" src="en-us_image_0000002105031992.png"></span></div>
</li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0040.html">Appendixes</a></div>
</div>
</div>