Help Center/ Organizations/ API Reference/ APIs/ Policy Dry Run Configurations/ Querying Policy Dry Run Configurations of an Organization

Updated on 2026-03-09 GMT+08:00

View PDF

Querying Policy Dry Run Configurations of an Organization

Function

This API is used to query policy dry run configurations of an organization. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:policies:getDryRunConfig	Read	root *	g:ResourceTag/<tag-key>	-	-

URI

GET /v1/organizations/dry-run-config

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
root_id	Yes	String	Unique ID of the root.
policy_type	Yes	String	Type of a dry-run policy. service_control_policy indicates a service control policy.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
root	DryRunConfigDto object	Details about policy dry run.

**Table 4** DryRunConfigDto
Parameter	Type	Description
root_id	String	Unique ID of the root.
status	String	Dry run status. It can be enabled, pending_enable, disabled, or pending_disable.
bucket_name	String	Name of a user bucket.
region_id	String	Region where a user bucket is located.
bucket_prefix	String	Prefix of a user bucket.
agency_name	String	Agency name. The Organizations service uses this agency to write dry-run logs to the OBS bucket.
policy_type	String	Type of a dry-run policy. service_control_policy indicates a service control policy.
created_at	String	Time when policy dry run is enabled.
updated_at	String	Time when policy dry run configurations are updated.

Example Requests

Querying policy dry run configurations of an organization

POST https://{endpoint}/v1/organizations/dry-run-policy

Example Responses

Status code: 200

Successful.

{
  "DryRunConfig" : {
    "root_id" : "r-o1qqtqfo7xl427v7g",
    "policy_type" : "service_control_policy",
    "bucket_name" : "",
    "region_id" : "",
    "bucket_prefix" : "",
    "agency_name" : "",
    "status" : "disabled",
    "created_at" : "2024-11-15T06:31:46Z",
    "updated_at" : "2024-11-15T06:31:46Z"
  }
}