Querying the Line Grade List
Function
This API is used to query the line grade list.
Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{domain_id}/gcb/line-levels
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. Minimum: 10 Maximum: 32 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Value range: 1 to 1000 Minimum: 1 Maximum: 1000 Default: 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. Minimum: 1 Maximum: 4096 |
id |
No |
Array |
Resource ID. Multiple IDs can be queried. Array Length: 1 - 20 |
local_area |
No |
String |
Local access point code included in the line specification. Minimum: 1 Maximum: 64 |
remote_area |
No |
String |
Remote access point code included in the line specification. Minimum: 1 Maximum: 64 |
levels |
No |
Array |
Bandwidth class.
Array Length: 1 - 10 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. Minimum: 0 Maximum: 2000000 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. Minimum: 32 Maximum: 36 |
page_info |
PageInfo object |
Pagination query information. |
line_levels |
Array of GlobalConnectionBandwidthLineLevel objects |
Response body for querying the line grade list. Array Length: 1 - 2000 |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Backward pagination identifier. Minimum: 1 Maximum: 4096 |
previous_marker |
String |
Forward pagination identifier. Minimum: 1 Maximum: 4096 |
current_count |
Integer |
Number of the resources in the current list. Minimum: 0 Maximum: 2000 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
description |
String |
Resource description. Angle brackets (<>) are not allowed. Minimum: 0 Maximum: 255 |
created_at |
String |
Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format. |
updated_at |
String |
Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format. |
local_area |
String |
Local access point. Minimum: 1 Maximum: 64 |
remote_area |
String |
Remote access point. Minimum: 1 Maximum: 64 |
levels |
Array of strings |
Line grade. There are three options: platinum, gold, and silver. Minimum: 1 Maximum: 36 Array Length: 1 - 10 |
Example Requests
Querying the line grade list
GET https://{cc_endpoint}/v3/{domain_id}/gcb/line-levels
Example Responses
Status code: 200
The line grade list has been queried.
{ "request_id" : "61126320a1802d5c6444f9d2d76526c2", "line_levels" : [ { "id" : "5c2d5343-cde2-4a41-83ae-56b7f44d73b5", "description" : "description", "local_area" : "site-abc", "remote_area" : "site-def", "levels" : [ "Pt", "Ag" ], "created_at" : "2024-01-24T08:26:41.914Z", "updated_at" : "2024-01-24T08:26:41.914Z" } ], "page_info" : { "next_marker" : "XXX", "previous_marker" : "XXX", "current_count" : 1 } }
Status Codes
Status Code |
Description |
---|---|
200 |
The line grade list has 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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot