Query Region List

Query the list of available regions and domain suffixes for creating a P-Series Cloud Edition.

Request URL

GET {base_url}/product/openapi/instance/v1/region_list

Request parameters

Headers
Parameter Required Description
User-Agent Yes Provide information about the user agent, such as the type of web browser, operating system, software version, etc., so as to help Yeastar Partner Portal to identify the user or the application that is making the request.

Example: User-Agent: OpenAPI.
Authorization Yes Pass the access token in the header, so as to authenticate the API request.

Format: Bearer {access_token}.

Response parameters

Parameter Type Description
code String The response message of the API request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
requestId String The unique ID of the request, which can be used to quickly locate the request.
result Object<Region_Info> The detailed information of the region.
status Integer The HTTP status code of the API request.
Region_Info
Parameter Type Description
id String The unique ID of the region.
name String The name of the region.
region Array<Domain_Info> The information of the available domain suffix(es) in the region.

Domain_Info

Parameter Type Description
pbxSubDomain Array<String> The list of the available domain suffix(es).
pbxSubDomainId String The unique ID of the domain suffix(es).

Example

Request example

GET /product/openapi/instance/v1/region_list HTTP/1.1
Host: openapi.partner.yeastar.com
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTE1NDU0NDY4NzY3NzQ0XCIsXCJ1c2VyQ29kZVwiOlwiUGFydG5lclwiLFwidXNlcklkXCI6XCIzMDc2OTE1NDU0NDg5NzM5MjY0XCIsXCJ1c2VybmFtZVwiOlwicGFydG5lcmV4YW1wbGVAb3V0bG9vay5jb21cIn0iLCJ1c2VyX25hbWUiOiJwYXJ0bmVyZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3Mzk2MjYxOTMsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwianRpIjoiTWw5K2ZkMWwvZVFnQUk4OXFIdXc5OXdidE9JPSIsImF1dGhvcml0aWVzIjpbIjc5Il0sImNsaWVudF9pZCI6IjE0NDI5NjM2ODBiMjM0YjA0YmRjZDVjMTZmODcyOWQ2In0.WRWzH-BktI4XRt5Msq8Q0LQm1Pv8rtWNHHHmxDYOLQQ

Response example

{
    "code": "success",
    "detailMessage": "",
    "requestId": "980d359439bdf9fc2828045a0b9dd137",
    "result": [
        {
            "id": "4",
            "name": "China(GuangDong)",
            "region": [
                {
                    "pbxSubDomain": [
                        "test.yeastarcloud.com"
                    ],
                    "pbxSubDomainId": "5"
                }
            ]
        },
        {
            "id": "47",
            "name": "China(sz-dual-net-card)",
            "region": [
                {
                    "pbxSubDomain": [
                        "commercial1.yeastar.com",
                        "commercial2.yeastar.com",
                        "pbxtest.yeastarcloud.com"
                    ],
                    "pbxSubDomainId": "48"
                }
            ]
        },
        {
            "id": "16",
            "name": "India(Mumbai)",
            "region": [
                {
                    "pbxSubDomain": [
                        "indiatest.yeastarcloud.com"
                    ],
                    "pbxSubDomainId": "7"
                }
            ]
        },
        {
            "id": "56",
            "name": "US(California)",
            "region": [
                {
                    "pbxSubDomain": [
                        "ustest.yeastarcloud.com"
                    ],
                    "pbxSubDomainId": "52"
                }
            ]
        }
    ],
    "status": 200
}