This is the multi-page printable view of this section. Click here to print.
List Usage Plans
1 - 1.3
scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
Get usage plans list
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Name | usage-plan-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | Usage Plan ID | 27bb070b564349f8a31cc60734cc36a5 |
| connected_api_keys | Connected API Keys | [‘key1’, ‘key2’] |
| created_at | Creation Date | |
| description | Description | description |
| limit | Usage Plan Limit | 10 |
| name | Name | usage-plan-name |
| rate | Usage Plan Rate | day |
2 - 1.2
scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
Get usage plans list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.2 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Name | usage-plan-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | Usage Plan ID | 27bb070b564349f8a31cc60734cc36a5 |
| connected_api_keys | Connected API Keys | [‘key1’, ‘key2’] |
| created_at | Creation Date | |
| description | Description | description |
| limit | Usage Plan Limit | 10 |
| name | Name | usage-plan-name |
| rate | Usage Plan Rate | day |
3 - 1.1
scpcli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
Get usage plans list
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 27bb070b564349f8a31cc60734cc36a5 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Name | usage-plan-name |
Responses
| Name | Description | Example |
|---|---|---|
| id | Usage Plan ID | 27bb070b564349f8a31cc60734cc36a5 |
| connected_api_keys | Connected API Keys | [‘key1’, ‘key2’] |
| created_at | Creation Date | |
| description | Description | description |
| limit | Usage Plan Limit | 10 |
| name | Name | usage-plan-name |
| rate | Usage Plan Rate | day |