DocsICP FilingConsole
Documentation

StopDcdnIpaDomain

Updated at:
Copy as MD
Product
My Favorites

Stops a specified accelerated domain name and changes the DomainStatus to offline.

Operation description

Note

  • After you stop an accelerated domain name, the information about the domain name is retained. Requests destined for the domain name are automatically forwarded to the origin.

  • Rate limit per user: 20 calls per second.

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

dcdn:StopDcdnIpaDomain

update

*IpaDomain

acs:dcdn:*:{#accountId}:domain/{#domainName}

 None None

Request parameters

Parameter

Type

Required

Description

Example
DomainName

string

Yes

The domain name that is added to DCDN IPA. You can specify only one domain name at a time.

example.com

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

15C66C7B-671A-4297-9187-2C4477247A74

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

Error codes

HTTP status code

Error code

Error message

Description
403 DcdnIpaServiceNotFound The DCDN IPA service has not been activated. IPA is not activated for DCDN.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.