Object Model
This section describes the object model for API groups.
- Operation Type indicates the operation that can be performed on a field.
C: create; U: update; R: read
- Mandatory indicates whether a field with the Operation Type of C is mandatory.
Parameter |
Data Type |
Description |
Operation Type |
Mandatory |
---|---|---|---|---|
ID |
String |
API group ID |
R |
- |
NAME |
String |
API group name |
CRU |
Yes |
STATUS |
Integer |
Status of the API group, which can be:
Default value: 1 This parameter is not used currently. |
R |
- |
SL_DOMAIN |
String |
Subdomain name that API Gateway automatically allocates to the API group. The subdomain name cannot be modified. |
R |
- |
SL_DOMAINS |
Array of strings |
List of subdomain names that API Gateway automatically allocates to the API group. These subdomain names cannot be modified. |
R |
- |
PROJECT_ID |
String |
ID of the tenant that creates the API group, that is, the owner of the API group |
- |
- |
DOMAIN_NAME |
String |
Name of the tenant that creates the API group |
||
REGISTER_TIME |
Timestamp |
Time when the API group is created. The value of this parameter is generated by the system by default. |
R |
- |
UPDATE_TIME |
Timestamp |
Time when the API group was last modified |
R |
- |
REMARK |
String |
Description of the API group, such as functions and usage |
CRU |
No |
THROTTLE_ID |
String |
ID of the request throttling policy that controls the number of times APIs in the API group can be accessed within a specified period
NOTE:
The value of this parameter indicates the total number of times all APIs in the API group can be accessed within a specified period, and not the number of times each API can be accessed within the period. |
RU |
- |
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