Queries the configurations in the canary release environment.
Usage note
The accelerated domain name that was added to CDN is required for calling this operation.
QPS limit
A single user can perform a maximum of 100 queries per minute. Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeLiveDomainStagingConfig |
The operation that you want to perform. Set the value to DescribeLiveDomainStagingConfig. |
DomainName | String | Yes | example.com |
The accelerated domain name. |
FunctionNames | String | Yes | aliauth |
The names of the features to query. Separate features with commas (,). |
RegionId | String | No | cn-shanghai |
The ID of the region. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DomainConfigs | Array of DomainConfig |
The configurations of the accelerated domain name. |
|
ConfigId | String | 6295 |
The ID of the configuration. |
FunctionArgs | Array of FunctionArg |
The configurations of the features. |
|
ArgName | String | auth_type |
The name of the configuration. |
ArgValue | String | req_auth |
The configured value. |
FunctionName | String | aliauth |
The name of the feature. |
Status | String | success |
The configuration status. Valid values:
|
RequestId | String | C80705BF-0F76-41FA-BAD1-5B59296A4E59 |
The ID of the request. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainStagingConfig
&DomainName=example.com
&FunctionNames=aliauth
&<Common request parameters>
Sample success responses
XML
format
<DescribeLiveDomainStagingConfigResponse>
<RequestId>C80705BF-0F76-41FA-BAD1-5B59296A4E59</RequestId>
<DomainConfigs>
<Status>success</Status>
<FunctionArgs>
<ArgName>auth_type</ArgName>
<ArgValue>req_auth</ArgValue>
</FunctionArgs>
<FunctionArgs>
<ArgName>ali_auth_dual</ArgName>
<ArgValue>on</ArgValue>
</FunctionArgs>
<ConfigId>6295</ConfigId>
<FunctionName>aliauth</FunctionName>
</DomainConfigs>
</DescribeLiveDomainStagingConfigResponse>
JSON
format
{
"RequestId": "C80705BF-0F76-41FA-BAD1-5B59296A4E59",
"DomainConfigs": [
{
"Status": "success",
"FunctionArgs": [
{
"ArgName": "auth_type",
"ArgValue": "req_auth"
},
{
"ArgName": "ali_auth_dual",
"ArgValue": "on"
}
],
"ConfigId": 6295,
"FunctionName": "aliauth"
}
]
}
Error codes
For a list of error codes, visit the API Error Center.