DescribeLiveDomainStagingConfig - - Alibaba Cloud Documentation Center

Operation description

Usage notes

You can call this operation to query the staging environment configuration of a specified accelerated domain name.

QPS limits

The single-user limit for this API operation is 30 queries per second (QPS). If you exceed this limit, API calls are throttled. This may affect your business. Pace your calls to stay within the limit. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveDomainStagingConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
DomainName	string	Yes	The accelerated domain name.	developer.aliyundoc.com
FunctionNames	string	Yes	The names of the features. Separate multiple feature names with commas (,).	aliauth

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	C80705BF-0F76-41FA-BAD1-5B59296A4E59
DomainConfigs	array<object>	The domain name configurations.
	array<object>
Status	string	The status of the configuration. Valid values: success: Successful. testing: The configuration is being verified. failed: Failed. configuring: The configuration is in progress.	success
ConfigId	string	The ID of the configuration.	6295
FunctionName	string	The name of the feature.	aliauth
FunctionArgs	array<object>	The configurations of the feature.
	object
ArgName	string	The name of the configuration parameter.	auth_type
ArgValue	string	The value of the configuration parameter.	req_auth

Examples

Success response

JSON format

{
  "RequestId": "C80705BF-0F76-41FA-BAD1-5B59296A4E59",
  "DomainConfigs": [
    {
      "Status": "success",
      "ConfigId": "6295",
      "FunctionName": "aliauth",
      "FunctionArgs": [
        {
          "ArgName": "auth_type",
          "ArgValue": "req_auth"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.