Query the service catalog
Function
This API is used to query a service catalog.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/service/servicecatalogs/{catalog_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
|
catalog_id |
Yes |
String |
Catalog ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service. |
|
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
|
Dlm-Type |
No |
String |
Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE. |
|
Content-Type |
Yes |
String |
Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
catalog_id |
String |
Catalog ID |
|
name |
String |
Name. |
|
path |
String |
Path. |
|
catalog_total |
Integer |
Number of subdirectories. |
|
api_total |
Integer |
Number of APIs |
|
description |
String |
Description. |
|
create_time |
Long |
Time when the bandwidth was specified. |
|
create_user |
String |
Creator. |
|
update_time |
Long |
Update time. |
|
update_user |
String |
Updater. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Requests
Query a catalog whose ID is 51159105c7838353d2834181d978af50.
/v1/0833a5737480d53b2f250010d01a7b88/service/servicecatalogs/51159105c7838353d2834181d978af50
Example Responses
Status code: 200
Success
{
"catalog_id" : "2847131b4d5a26c5bd4bfd9d8f63f577",
"name" : "demo",
"path" : "/demo1/demo2/demo",
"catalog_total" : 1,
"api_total" : 1,
"description" : "this is a demo",
"create_time" : 1578284788000,
"create_user" : "Tom",
"update_time" : 1578284788000,
"update_user" : "Tom"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Success |
|
400 |
Bad request |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.