Querying Central Network Capabilities
Function
This API is used to query central network capabilities.
URI
GET /v3/{domain_id}/gcn/capabilities
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
capability |
No |
Array of arrays |
Capabilities. Multiple capabilities can be queried. |
limit |
No |
Integer |
Number of records returned on each page. Value range: 1-1000 |
marker |
No |
String |
Pagination query information. You can obtain the marker values from the response of the last API call. You can enter the marker value of the previous page or the next page. If you enter the marker value of the previous page, the previous page will be queried. If you enter the marker value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the limit value, cannot be modified. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
page_info |
PageInfo object |
Pagination query information. |
capabilities |
Array of CentralNetworkCapability objects |
List of central network capabilities. |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Backward pagination identifier. |
previous_marker |
String |
Forward pagination identifier. |
current_count |
Integer |
Number of the resources in the current list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
domain_id |
String |
ID of the account that the instance belongs to. |
capability |
String |
Central network capabilities.
|
Example Requests
Querying central network capabilities
GET https://{cc_endpoint}/v3/gcn/capabilities
Example Responses
Status code: 200
Central network capabilities have been queried.
{ "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "page_info" : { "current_count" : 1 }, "capabilities" : [ { "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "domain_id" : "XXX", "capability" : "central-network.is-support", "specifications" : { "is_support" : true } } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Central network capabilities have been queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.