Querying Details of a Purchased API Group
Function
This API is used to query the details of a purchased API group.
URI
The following table lists the HTTP/HTTPS request method and URI of the API.
Request Method |
URI |
---|---|
GET |
/v1.0/apigw/purchases/groups/{purchase_id} |
The following table lists the parameter in the URI.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
purchase_id |
Yes |
String |
Subscription ID |
Request
N/A
Response
Parameter |
Type |
Description |
---|---|---|
id |
String |
Subscription ID |
group_id |
String |
API group ID |
group_name |
String |
API group name |
group_remark |
String |
Description of the API group |
order_time |
Timestamp |
Time when the order is placed |
start_time |
Timestamp |
Time when the order takes effect |
expire_time |
Timestamp |
Time when the order expires |
group_domains |
[]String |
List of API group domain names. A value will be returned when you query the details of a purchased API group. |
quota_left |
Integer |
Remaining API call quota |
quota_used |
Integer |
Used API call quota |
app_key |
String |
Generated AppKey |
app_secret |
String |
Generated AppSecret |
Example response:
{ "id": "3f30d49b-220f-4b11-9e94-c2fd3c1cc587", "group_id": "73c58022-f20d-495a-a188-85d718647f09", "group_name": "api_group_001", "group_remark": "API group 001", "group_domains": [ "test.market.example.com" ], "quota_used": 0, "quota_left": 2000000000, "order_time": "2018-01-02T10: 51: 26Z", "start_time": "2018-01-01T00: 00: 00Z", "expire_time": "2019-01-01T00: 00: 00Z", "app_key": "0e242685-661d-4254-a8bb-be9a92b04785", "app_secret": "******" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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