Querying Instance tenant-sync
Function
This API is used to query instance tenant-sync.
URI
GET /v2/{project_id}/tenant-sync/{instance_id}
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
sync_enabled |
Boolean |
Whether TenantSync is enabled. |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Status code: 500
Parameter |
Type |
Description |
|---|---|---|
error_msg |
String |
Error message. Maximum: 1024 |
error_code |
String |
Error code. Maximum: 9 |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. Maximum: 1024 |
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/tenant-sync/{instance_id}
Example Responses
Status code: 200
Instance tenant-sync queried.
{
"sync_enabled" : true
}
Status code: 500
Internal service error.
{
"error_msg" : "Internal service error.",
"error_code" : "DCS.5000",
"error_ext_msg" : null
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Instance tenant-sync queried. |
400 |
Invalid request. |
500 |
Internal service 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.
