Querying Landing Zone Setup Status

Function

This API is used to query the status of landing zone setup.

URI

GET https://{endpoint}/v1/landing-zone/status

Request Parameters

None

Response Parameters

Status code: 200

**Table 1** Response body parameters
Parameter	Type	Description
deployed_version	String	Version of the deployed landing zone.
landing_zone_status	String	Setup status of the landing zone. It can be processing or completed.
percentage_complete	Integer	Progress of setting up a landing zone.
percentage_details	Array of PercentageDetail objects	Setup details of a landing zone.
landing_zone_action_type	String	Actions to be performed in the landing zone.
message	Array of LandingZoneErrorMessage objects	Error messages about the landing zone.
regions	Array of RegionConfigurationList objects	Information about a governed region.

**Table 2** PercentageDetail
Parameter	Type	Description
percentage_name	String	Progress name.
percentage_status	String	Progress.

**Table 3** LandingZoneErrorMessage
Parameter	Type	Description
level	String	Severity of a landing zone error.
message	String	Error details of the landing zone.

**Table 4** RegionConfigurationList
Parameter	Type	Description
region	String	Region name.
region_configuration_status	String	Region status.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of the request.
encoded_authorization_message	String	Encrypted error message.
details	Array of ForbiddenErrorDetail objects	Error message indicating no permissions for cross-service invoking.

**Table 6** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Querying the status of landing zone setup

GET https://{endpoint}/v1/landing-zone/status

Example Responses

Status code: 200

Request succeeded.

{
  "deployed_version" : "string",
  "landing_zone_status" : "string",
  "percentage_complete" : 100,
  "percentage_details" : [ {
    "percentage_name" : "string",
    "percentage_status" : "string"
  } ],
  "landing_zone_action_type" : "string",
  "message" : [ {
    "level" : "string",
    "message" : "string"
  } ],
  "regions" : [ {
    "region" : "string",
    "region_configuration_status" : "ENABLED"
  } ]
}