Binding an Access Control Policy to an API
Function
This API is used to bind an access control policy to a specified API.
You can bind different access control policies to an API in different environments, but you can bind only one access control policy to the API in each environment.
URI
POST /v2/{project_id}/apic/instances/{instance_id}/acl-bindings
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
acl_id |
Yes |
String |
Access control policy ID. Minimum: 1 Maximum: 65 |
publish_ids |
Yes |
Array of strings |
API publication record ID. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
acl_bindings |
Array of AclApiBindingInfo objects |
Access control policy binding record list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Binding ID. |
api_id |
String |
API ID. |
env_id |
String |
Environment ID. |
acl_id |
String |
Access control policy ID. |
create_time |
String |
Time when the policy is bound to the API. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
{ "acl_id" : "7eb619ecf2a24943b099833cd24a01ba", "publish_ids" : [ "40e7162dc6b94bbbbb1a60d2a24b1b0c" ] }
Example Responses
Status code: 201
Created
{ "acl_bindings" : [ { "id" : "332c5db1458a477b89b2ea741fec94a3", "api_id" : "5f918d104dc84480a75166ba99efff21", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "acl_id" : "7eb619ecf2a24943b099833cd24a01ba", "create_time" : "2020-08-04T08:58:03.001228747Z" } ] }
Status code: 400
Bad Request
{ "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:acl_id. Please refer to the support documentation" }
Status code: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" }
Status code: 404
Not Found
{ "error_code" : "APIG.3006", "error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist" }
Status code: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Status Codes
Status Code |
Description |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
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