Listing Endpoints
Function
This API is used to list all endpoints. An endpoint provides an entry to a specific service.
The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.
Debugging
You can debug this API in API Explorer.
URI
GET /v3/endpoints
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
interface |
No |
String |
Plane which the endpoint belongs to. |
service_id |
No |
String |
Service ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Fill application/json;charset=utf8 in this field. |
X-Auth-Token |
Yes |
String |
IAM user token (no special permission requirements). |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
Array of objects |
Resource link. |
|
Object |
Endpoint information. |
Parameter |
Type |
Description |
---|---|---|
service_id |
String |
ID of the service which the endpoint belongs to. |
region_id |
String |
ID of the region which the endpoint belongs to. |
Object |
Endpoint resource link information. |
|
id |
String |
Endpoint ID. |
interface |
String |
Plane which the endpoint belongs to. |
region |
String |
Region which the endpoint belongs to. |
url |
String |
Endpoint URL. |
enabled |
Boolean |
Enabling status of the endpoint. |
Example Request
Request for querying endpoints
GET https://iam.myhuaweicloud.com/v3/endpoints
Example Response
Status code: 200
The request is successful.
{ "endpoints": [ { "service_id": "3e93d3eb20b34bfbbdcc81a79c1c3045", "region_id": "ap-southeast-1", "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/endpoints/0046cca357c94165b7a10ec2c01bdf60" }, "id": "0046cca357c94165b7a10ec2c01bdf60", "interface": "public", "region": "ap-southeast-1", "url": "https://ims.sample.domain.com", "enabled": true }, { "service_id": "5186586acd38461d84b3dbf9f02e33ae", "region_id": "ap-southeast-1", "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/endpoints/00d546d4823e452491407284ab26612c" }, "id": "00d546d4823e452491407284ab26612c", "interface": "public", "region": "ap-southeast-1", "url": "https://ges.sample.domain.com/v1.0/$(tenant_id)s", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://iam.myhuaweicloud.com/v3/endpoints" } }
Status Codes
Status Code |
Description |
---|---|
200 |
The request is successful. |
400 |
Invalid parameters. |
401 |
Authentication failed. |
403 |
Access denied. |
404 |
The requested resource cannot be found. |
405 |
The method specified in the request is not allowed for the requested resource. |
413 |
The request entity is too large. |
501 |
The API is not available. |
503 |
Service unavailable. |
Error Codes
None
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